Doc

async_codegen::rust

Enum Doc 

Source 
pub enum Doc<Value> {
    Hidden,
    Inline,
    NoInline,
    Alias(Value),
    Test(Value),
}
Expand description

A doc attribute on an item.

The generic argument of this enum is not used in all variants. Consider using the constructor functions Self::hidden, Self::inline, and Self::no_inline if applicable

Variants§

§

Hidden

The #[doc(hidden)] attribute

§

Inline

The #[doc(inline)] attribute

§

NoInline

The #[doc(no_inline)] attribute

§

Alias(Value)

Creates an alias to another item with #[doc(alias = "Value")]

§

Test(Value)

Creates a documentation test attribute with #[doc(test(Value))]

Implementations§

Source§

impl Doc<NoOp>

Source

pub fn hidden() -> Doc<NoOp>

The #[doc(hidden)] attribute

Source

pub fn inline() -> Doc<NoOp>

The #[doc(inline)] attribute

Source

pub fn no_inline() -> Doc<NoOp>

The #[doc(no_inline)] attribute

Trait Implementations§

Source§

impl<Value: Clone> Clone for Doc<Value>

Source§

fn clone(&self) -> Doc<Value>

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
Source§

impl<Value: Debug> Debug for Doc<Value>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<O, Value> Writable<O> for Doc<Value>
where O: Output, Value: Writable<O>,

Source§

async fn write_to(&self, output: &mut O) -> Result<(), O::Error>

Writes to the output. Returns the output’s error upon failure. Read more

Auto Trait Implementations§

§

impl<Value> Freeze for Doc<Value>
where Value: Freeze,

§

impl<Value> RefUnwindSafe for Doc<Value>
where Value: RefUnwindSafe,

§

impl<Value> Send for Doc<Value>
where Value: Send,

§

impl<Value> Sync for Doc<Value>
where Value: Sync,

§

impl<Value> Unpin for Doc<Value>
where Value: Unpin,

§

impl<Value> UnwindSafe for Doc<Value>
where Value: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.