Struct KeySpec 

pub struct KeySpec {
    pub notes: &'static str,
    pub flags: &'static [&'static str],
    pub begin: Begin,
    pub find: Find,
}

One run of keys in a command’s arguments.

Fields

notes: &'static str

What the reference says about this spec, empty for most of them.

Carried because COMMAND DOCS reports it and because every one of them explains a spec that would otherwise read as a mistake.

flags: &'static [&'static str]

How the value is touched and what a caller has to be allowed to do.

begin: Begin

Where the run starts.

find: Find

How far it goes.

Implementations

impl KeySpec

pub fn access(&self) -> Access

What a caller needs over the keys this spec names.

pub fn incomplete(&self) -> bool

Whether this spec is a floor rather than the whole answer.

pub fn fake(&self) -> bool

Whether this spec names an argument that looks like a key and is not.

SPUBLISH’s channel is one, and it is the reason that command answers COMMAND GETKEYS with an error rather than the channel name.

Trait Implementations

impl Clone for KeySpec

fn clone(&self) -> KeySpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for KeySpec

impl Debug for KeySpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.