Enum DocAttribute

#[non_exhaustive]pub enum DocAttribute<'a> {
    LitStr(Cow<'a, LitStr>),
    IncludeStr(IncludeStrMacro<'a>),
    Inline,
    Other(Cow<'a, Attribute>),
}

Expand description

A Doc Attribute

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

LitStr(Cow<'a, LitStr>)

#[doc = "Hello World"]

IncludeStr(IncludeStrMacro<'a>)

#[doc = include_str!("path/to/file")]

Inline

#[doc(inline)]

Other(Cow<'a, Attribute>)

More Doc Attributes will be added

Implementations§

impl DocAttribute<'static>

pub fn parse_inner(input: ParseStream<'_>) -> Result<Vec<DocAttribute<'static>>>

Parses all attributes then filters out the doc attributes and parses them

§Returns

A Vec of DocAttributes

impl DocAttribute<'_>

pub fn to_string(&self) -> Result<Option<String>, IOOrParseError>

Returns LitString as a String if it is a LitStr Reads the file if it is an include_str!()

§Returns

Ok(None) - the attribute does not have a comment or map to include_str!()

Trait Implementations§

impl<'a> Clone for DocAttribute<'a>

fn clone(&self) -> DocAttribute<'a>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<'a> Debug for DocAttribute<'a>

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

Formats the value using the given formatter. Read more

impl ToTokens for DocAttribute<'_>

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream. Read more

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object. Read more

fn into_token_stream(self) -> TokenStream
where Self: Sized,

Convert self directly into a TokenStream object. Read more

impl<'a> TryFrom<&'a Attribute> for DocAttribute<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(attribute: &'a Attribute) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Attribute> for DocAttribute<'static>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(attribute: Attribute) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl<'a> Freeze for DocAttribute<'a>

impl<'a> RefUnwindSafe for DocAttribute<'a>

impl<'a> !Send for DocAttribute<'a>

impl<'a> !Sync for DocAttribute<'a>

impl<'a> Unpin for DocAttribute<'a>

impl<'a> UnwindSafe for DocAttribute<'a>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Spanned for T
where T: Spanned + ?Sized,

fn span(&self) -> Span

Returns a Span covering the complete contents of this syntax tree node, or Span::call_site() if this node is empty.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.