Enum user_doc_doc_data::HelperAttr

pub enum HelperAttr {
    ChapterNum(usize),
    ChapterNumSlug(Vec<usize>),
    ChapterName(String),
    ChapterNameSlug(Vec<String>),
    ChapterBlurb(String),
}

Attribute helpers

When written in snake case (eg. ChapterNum -> chapter_num), the variants of this enum correspond to the

• helper attributes supported by the user_doc_item derive macro:

#[derive(user_doc_item)]
// This line will NOT be in the produced documentation.
struct SomeStruct {
  #[chapter_name("A chapter")]
  #[chapter_num(333)]
  // This line will be in the produced documentation.
  some_field: u8
}

• arguments supported by the user_doc_fn attribute macro:

#[user_doc_fn(chapter_name("A chapter"), chapter_num(333))]
// This line will be in the produced documentation.
fn some_fn() -> () {}

The preceding examples both produce the same user-facing documentation. If both examples occurred in the same project, however, one would overwrite the other.

Variants

ChapterNum

Number of this chapter

Tuple Fields of ChapterNum

0: usize

ChapterNumSlug

Number-path up to and including this chapter

Tuple Fields of ChapterNumSlug

0: Vec<usize>

ChapterName

Name of this chapter

Tuple Fields of ChapterName

0: String

ChapterNameSlug

Name-path up to and including this chapter

Tuple Fields of ChapterNameSlug

0: Vec<String>

ChapterBlurb

A blurb to add to the page for the chapter

Tuple Fields of ChapterBlurb

0: String

Implementations

impl HelperAttr

pub fn from_attribute_args(a: &AttributeArgs) -> Result<Vec<Self>>

Instantiate from an AttributeArgs (Vec)

pub fn from_attribute(a: &Attribute) -> Result<Self>

Instantiate from an Attribute if said Attribute represents a valid HelperAttr

Trait Implementations

impl AsRef<str> for HelperAttr

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for HelperAttr

fn clone(&self) -> HelperAttr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HelperAttr

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

Formats the value using the given formatter.

impl From<&'_ HelperAttr> for Path

fn from(h: &HelperAttr) -> Self

Performs the conversion.

impl IntoEnumIterator for HelperAttr

type Iterator = HelperAttrIter

fn iter() -> HelperAttrIter

impl Ord for HelperAttr

fn cmp(&self, other: &HelperAttr) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<HelperAttr> for HelperAttr

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

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

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

This method tests for !=.

impl PartialOrd<HelperAttr> for HelperAttr

fn partial_cmp(&self, other: &HelperAttr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for HelperAttr

impl StructuralEq for HelperAttr

impl StructuralPartialEq for HelperAttr