Struct Context 

pub struct Context(/* private fields */);

A structure that holds several CompiledProgramAnalysers which are used to analyse one or more compiled Yarn programs with Dialogue::analyse. To get the analysis results, call Context::finish_analysis afterwards.

Implementations

impl Context

pub fn empty() -> Context

Creates a new empty Context with no analysers.

pub fn default_analysers() -> Context

Sets up a Context with the default analysers. These are:

• Variable Lister: Adds a DiagnosisSeverity::Note diagnosis for each variable in the program.
• Unused Variable Checker: Adds a DiagnosisSeverity::Warning diagnosis for each unused variable in the program.

pub fn add_analyser(self, analyser: Box<dyn CompiledProgramAnalyser>) -> Context

Adds an analyser to the Context.

pub fn finish_analysis(&self) -> Vec<Diagnosis>

Collects the diagnoses from all analysers in the Context that were previously used with Dialogue::analyse.

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.

impl Extend<Box<dyn CompiledProgramAnalyser>> for Context

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Box<dyn CompiledProgramAnalyser>>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl IntoIterator for Context

type Item = Box<dyn CompiledProgramAnalyser>

The type of the elements being iterated over.

type IntoIter = IntoIter<<Context as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Context as IntoIterator>::IntoIter

Creates an iterator from a value.