Struct Parameter 

pub struct Parameter {

    pub novalue: bool,
    pub semiverbatim: Option<Vec<char>>,
    pub optional: bool,
    pub name: SymStr,
    pub spec: SymStr,
    pub extra: Vec<Tokens>,
    pub inner: Option<Parameters>,
    pub reader: ReaderClosure,
    pub predigest: Option<ReaderPredigestClosure>,
    pub reversion: Option<ReversionClosure>,
    pub digested_reversion: Option<DigestedReversionClosure>,
    pub before_digest: Vec<BeforeDigestClosure>,
    pub after_digest: Vec<DigestionClosure>,
}

Fields

novalue: bool

semiverbatim: Option<Vec<char>>

optional: bool

name: SymStr

spec: SymStr

extra: Vec<Tokens>

inner: Option<Parameters>

reader: ReaderClosure

predigest: Option<ReaderPredigestClosure>

reversion: Option<ReversionClosure>

digested_reversion: Option<DigestedReversionClosure>

Reversion closure that operates on the original Digested argument. Takes precedence over reversion when the argument is a digested value. Perl equivalent: reversion option on DefParameterType with undigested => 1.

before_digest: Vec<BeforeDigestClosure>

after_digest: Vec<DigestionClosure>

Implementations

impl Parameter

pub fn new<T: AsRef<str>>( name: T, spec: T, extra: Option<Vec<Tokens>>, ) -> Result<Self>

pub fn init(self) -> Result<Self>

pub fn check_reader_function(name: &str) -> Option<ReaderClosure>

Obtain the reader of a given parameter name, if available

pub fn setup_catcodes(&self)

pub fn revert_catcodes(&self) -> Result<()>

pub fn read(&self, fordefn: Option<&dyn Definition>) -> Result<ArgWrap>

pub fn digest( &self, value_arg: ArgWrap, _fordefn: Option<&Constructor>, ) -> Result<Option<Digested>>

pub fn revert(&self, value_opt: Option<Tokens>) -> Result<Option<Tokens>>

pub fn reparse(&self, tokens: Tokens) -> Result<ArgWrap>

This is needed by structured parameter types like KeyVals where the argument may already have been tokenized before the KeyVals (and the parameter types for the keys) had a chance to properly parse.

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl Default for Parameter

fn default() -> Self

Returns the “default value” for a type.

impl Display for Parameter

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

Formats the value using the given formatter.

impl From<Parameter> for Stored

fn from(value: Parameter) -> Self

Converts to this type from the input type.

impl Object for Parameter

fn stringify(&self) -> String

fn isa_box(&self) -> bool

fn is_expandable(&self) -> bool

fn is_definition(&self) -> bool

fn is_comment(&self) -> bool

fn be_digested(self) -> Result<Digested>

where Self: Sized + Debug,

fn get_locator(&self) -> Option<Locator>

The object’s stored source locator, if it has one. None is the honest “no recorded source position” (replacing the old Locator::default() file!()/line!() sentinel). For “where the parser is now” (error reporting, box creation), use the free fn gullet::get_locator().

fn revert(&self) -> Result<Tokens>

each concrete object needs to provide its own path back to tokens

impl PartialEq for Parameter

fn eq(&self, other: &Parameter) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl ToTokens for Parameter

Available on crate feature codegen only.

fn to_tokens(&self, stream: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.