Enum doxygen_rs::parser::Value

pub enum Value {
    Notation(String, NestedString),
    Text(NestedString),
    Separator,
    Continuation(String, usize, bool),
    Unknown,
}

The enum used to represent the distinct raw values of a comment

Variants

Notation(String, NestedString)

The first String is the notation found, and .top of NestedString are the contents without the notation; the .sub of NestedString is a vector that contains consecutive list (lines starting with “-”)

Text(NestedString)

Raw text, without notation

Separator

Double new-line, or any other separator

Continuation(String, usize, bool)

indented Text- probably continuation of previous line; String- line text stripped of leading whitespaces & sublist characters as ‘-’,’*’and ‘+’; usize - number of leading whitespaces; bool- sublist char present?

Unknown

Unknown value

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl PartialEq<Value> for Value

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Value

impl StructuralEq for Value

impl StructuralPartialEq for Value