Struct DocumentationAnnotations 

pub struct DocumentationAnnotations {
    pub examples: Vec<String>,
    pub see_also: Vec<String>,
    pub links: Vec<String>,
    pub notes: Vec<String>,
    pub warnings: Vec<String>,
    pub todos: Vec<String>,
}

@acp:summary “Documentation metadata for a symbol (RFC-0009)”

Fields

examples: Vec<String>

Code examples (from @acp:example)

see_also: Vec<String>

References to related symbols (from @acp:see)

links: Vec<String>

External documentation URLs (from @acp:link)

notes: Vec<String>

Important notes (from @acp:note)

warnings: Vec<String>

Warnings about usage (from @acp:warning)

todos: Vec<String>

Pending work items (from @acp:todo)

Implementations

impl DocumentationAnnotations

pub fn is_empty(&self) -> bool

Check if documentation annotations are empty (for skip_serializing)

Trait Implementations

impl Clone for DocumentationAnnotations

fn clone(&self) -> DocumentationAnnotations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentationAnnotations

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

Formats the value using the given formatter.

impl Default for DocumentationAnnotations

fn default() -> DocumentationAnnotations

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentationAnnotations

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentationAnnotations

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

where __S: Serializer,

Serialize this value into the given Serde serializer.