Struct MentionFile 

pub struct MentionFile {
    pub mentions: Vec<Mention>,
    pub extra: BTreeMap<String, Value>,
}

One target’s mention file (docs/mentions/<slug>.toml).

The file is a table with one mention array of tables, so a hand-edited file with its own top-level keys keeps them (the same preservation rule as Mention::extra).

Fields

mentions: Vec<Mention>

The target’s mentions, in the order they appear in the issue(s).

extra: BTreeMap<String, Value>

Unknown top-level keys, preserved on rewrite.

Implementations

impl MentionFile

pub fn new(mentions: Vec<Mention>) -> Self

Wrap an explicit list of mentions.

pub fn is_empty(&self) -> bool

Whether the document holds nothing at all — the state in which its file is removed rather than written empty.

Trait Implementations

impl Clone for MentionFile

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MentionFile

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

Formats the value using the given formatter.

impl Default for MentionFile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MentionFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MentionFile

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MentionFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MentionFile