Struct mentat::vocabulary::SimpleVocabularySource

[+] Show type declaration

pub struct SimpleVocabularySource {
    pub definitions: Vec<Definition>,
    pub pre: Option<fn(_: &mut InProgress) -> Result<()>>,
    pub post: Option<fn(_: &mut InProgress) -> Result<()>>,
}

[−] Expand description

A convenience struct to package simple pre and post functions with a collection of vocabulary Definitions.

Fields

definitions: Vec<Definition>

pre: Option<fn(_: &mut InProgress) -> Result<()>>

post: Option<fn(_: &mut InProgress) -> Result<()>>

Methods

impl SimpleVocabularySource

[−]

pub fn new(     definitions: Vec<Definition>,     pre: Option<fn(_: &mut InProgress) -> Result<()>>,     post: Option<fn(_: &mut InProgress) -> Result<()>> ) -> SimpleVocabularySource

pub fn with_definitions(definitions: Vec<Definition>) -> SimpleVocabularySource

Trait Implementations

impl VocabularySource for SimpleVocabularySource

[+]

fn pre(     &mut self,     in_progress: &mut InProgress,     _checks: &VocabularyStatus ) -> Result<()>

[−]

Called before the supplied Definitions are transacted. Do not commit the InProgress. If this function returns Err, the entire vocabulary operation will fail.

fn post(&mut self, in_progress: &mut InProgress) -> Result<()>

[−]

Called after the supplied Definitions are transacted. Do not commit the InProgress. If this function returns Err, the entire vocabulary operation will fail.

Important traits for Vec<u8>

impl Write for Vec<u8>

fn definitions(&mut self) -> Vec<Definition>

[−]

Called to obtain the list of Definitions to install. This will be called before pre.