Enum DocAtom

pub enum DocAtom {
    Flag(Symbol),
    KeyValue {
        key: Symbol,
        value: Symbol,
    },
}

Variants

Flag(Symbol)

eg. #[doc(hidden)]

KeyValue

eg. #[doc(alias = "it")]

Note that a key can have multiple values that are all considered “active” at the same time. For example, #[doc(alias = "x")] and #[doc(alias = "y")].

Fields

key: Symbol

value: Symbol

Trait Implementations

impl Clone for DocAtom

fn clone(&self) -> DocAtom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocAtom

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

Formats the value using the given formatter.

impl From<DocAtom> for DocExpr

fn from(atom: DocAtom) -> Self

Converts to this type from the input type.

impl Hash for DocAtom

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DocAtom

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for DocAtom

impl StructuralPartialEq for DocAtom