bookclerk_plugin_abi::plugin_capnp::cli_arg_spec

Development These docs follow the development version and change with every merge.

Last updated View as Markdown

Item Kind Summary
Owned struct
Reader struct
Builder struct
Pipeline struct

Structs

Owned

pub struct Owned(/* private */);

Implements: Clone, Copy, Introspect, Owned, OwnedStruct, Pipelined, SetterInput<Owned>

Reader

pub struct Reader<'a> {
    /* private fields */
}

Reader::reborrow

pub fn reborrow(&self) -> Reader<'_>

Reader::total_size

pub fn total_size(&self) -> Result<MessageSize>

Reader::get_name

pub fn get_name(self) -> Result<Reader<'a>>

Reader::has_name

pub fn has_name(&self) -> bool

Reader::get_long

pub fn get_long(self) -> Result<Reader<'a>>

Reader::has_long

pub fn has_long(&self) -> bool

Reader::get_short

pub fn get_short(self) -> Result<Reader<'a>>

Reader::has_short

pub fn has_short(&self) -> bool

Reader::get_kind

pub fn get_kind(self) -> Result<CliArgKind, NotInSchema>

Reader::get_required

pub fn get_required(self) -> bool

Reader::get_default

pub fn get_default(self) -> Result<Reader<'a>>

Reader::has_default

pub fn has_default(&self) -> bool

Reader::get_about

pub fn get_about(self) -> Result<Reader<'a>>

Reader::has_about

pub fn has_about(&self) -> bool

Reader::get_positional

pub fn get_positional(self) -> bool

Implements: Clone, Copy, Debug, From<Reader<'a>>, From<StructReader<'a>>, FromPointerReader<'a>, HasTypeId, Imbue<'a>, IntoInternalStructReader<'a>, SetterInput<Owned>

Builder

pub struct Builder<'a> {
    /* private fields */
}

Builder::into_reader

pub fn into_reader(self) -> Reader<'a>

Builder::reborrow

pub fn reborrow(&mut self) -> Builder<'_>

Builder::reborrow_as_reader

pub fn reborrow_as_reader(&self) -> Reader<'_>

Builder::total_size

pub fn total_size(&self) -> Result<MessageSize>

Builder::get_name

pub fn get_name(self) -> Result<Builder<'a>>

Builder::set_name

pub fn set_name(&mut self, value: impl SetterInput<Owned>)

Builder::init_name

pub fn init_name(self, size: u32) -> Builder<'a>

Builder::has_name

pub fn has_name(&self) -> bool

Builder::get_long

pub fn get_long(self) -> Result<Builder<'a>>

Builder::set_long

pub fn set_long(&mut self, value: impl SetterInput<Owned>)

Builder::init_long

pub fn init_long(self, size: u32) -> Builder<'a>

Builder::has_long

pub fn has_long(&self) -> bool

Builder::get_short

pub fn get_short(self) -> Result<Builder<'a>>

Builder::set_short

pub fn set_short(&mut self, value: impl SetterInput<Owned>)

Builder::init_short

pub fn init_short(self, size: u32) -> Builder<'a>

Builder::has_short

pub fn has_short(&self) -> bool

Builder::get_kind

pub fn get_kind(self) -> Result<CliArgKind, NotInSchema>

Builder::set_kind

pub fn set_kind(&mut self, value: CliArgKind)

Builder::get_required

pub fn get_required(self) -> bool

Builder::set_required

pub fn set_required(&mut self, value: bool)

Builder::get_default

pub fn get_default(self) -> Result<Builder<'a>>

Builder::set_default

pub fn set_default(&mut self, value: impl SetterInput<Owned>)

Builder::init_default

pub fn init_default(self, size: u32) -> Builder<'a>

Builder::has_default

pub fn has_default(&self) -> bool

Builder::get_about

pub fn get_about(self) -> Result<Builder<'a>>

Builder::set_about

pub fn set_about(&mut self, value: impl SetterInput<Owned>)

Builder::init_about

pub fn init_about(self, size: u32) -> Builder<'a>

Builder::has_about

pub fn has_about(&self) -> bool

Builder::get_positional

pub fn get_positional(self) -> bool

Builder::set_positional

pub fn set_positional(&mut self, value: bool)

Implements: From<Builder<'a>>, From<StructBuilder<'a>>, FromPointerBuilder<'a>, HasStructSize, HasTypeId, ImbueMut<'a>

Pipeline

pub struct Pipeline {
    /* private fields */
}

Implements: FromTypelessPipeline

Generated from crates/bookclerk-plugin-abi at main · View as Markdown