Enum doku::Example

pub enum Example {
    Literal(&'static str),
    Simple(&'static str),
    Compound(&'static [&'static str]),
}

Variants

Literal(&'static str)

#[doku(literal_example = "foo")]

Simple(&'static str)

#[doku(example = "foo")]

Compound(&'static [&'static str])

#[doku(example = "one", example = "two")]

Implementations

impl Example

pub fn first(self) -> Option<&'static str>

pub fn iter(self) -> impl Iterator<Item = &'static str>

Trait Implementations

impl Clone for Example

fn clone(&self) -> Example

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Example

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

Formats the value using the given formatter.

impl From<&'static [&'static str]> for Example

fn from(examples: &'static [&'static str]) -> Self

Converts to this type from the input type.

impl From<&'static str> for Example

fn from(example: &'static str) -> Self

Converts to this type from the input type.

impl Copy for Example