Enum DocBlock 

pub enum DocBlock {
    Heading {
        level: u8,
        text: String,
    },
    Prose(String),
    Fixture {
        id: String,
    },
    Props,
    Controls,
    Source,
    Callout {
        tone: CalloutTone,
        title: String,
        body: String,
    },
    Custom {
        id: String,
        payload: String,
    },
}

Variants

Heading

Fields

level: u8

text: String

Prose(String)

Fixture

Fields

id: String

Props

Controls

Source

Callout

Fields

tone: CalloutTone

title: String

body: String

Custom

Fields

id: String

payload: String

Implementations

impl DocBlock

pub fn heading(level: u8, text: impl Into<String>) -> Self

pub fn prose(text: impl Into<String>) -> Self

pub fn fixture(id: impl Into<String>) -> Self

pub const fn props() -> Self

pub const fn controls() -> Self

pub const fn source() -> Self

pub fn custom(id: impl Into<String>, payload: impl Into<String>) -> Self

pub fn callout( tone: CalloutTone, title: impl Into<String>, body: impl Into<String>, ) -> Self

Trait Implementations

impl Clone for DocBlock

fn clone(&self) -> DocBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocBlock

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

Formats the value using the given formatter.

impl Eq for DocBlock

impl PartialEq for DocBlock

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocBlock