Struct Comments

pub struct Comments {
    pub revisions: Option<Vec<String>>,
    pub revisioned: BTreeMap<Vec<String>, Revisioned>,
}

This crate supports various magic comments that get parsed as file-specific configuration values. This struct parses them all in one go and then they get processed by their respective use sites.

Fields

revisions: Option<Vec<String>>

List of revision names to execute. Can only be specified once

revisioned: BTreeMap<Vec<String>, Revisioned>

Comments that are only available under specific revisions. The defaults are in key vec![]

Implementations

impl Comments

pub fn find_one_for_revision<'a, T: 'a>( &'a self, revision: &'a str, kind: &str, f: impl Fn(&'a Revisioned) -> OptWithLine<T>, ) -> Result<OptWithLine<T>, Errored>

Check that a comment isn’t specified twice across multiple differently revisioned statements. e.g. //@[foo, bar] error-in-other-file: bop and //@[foo, baz] error-in-other-file boop would end up specifying two error patterns that are available in revision foo.

pub fn for_revision<'a>( &'a self, revision: &'a str, ) -> impl Iterator<Item = &'a Revisioned>

Returns an iterator over all revisioned comments that match the revision.

pub fn base(&mut self) -> &mut Revisioned

The comments set for all revisions

pub fn base_immut(&self) -> &Revisioned

The comments set for all revisions

Trait Implementations

impl Clone for Comments

fn clone(&self) -> Comments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Comments

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

Formats the value using the given formatter.

impl Default for Comments

fn default() -> Self

Returns the “default value” for a type.