Enum doc_chunks::literal::CommentVariant

source · [−]

#[non_exhaustive]
pub enum CommentVariant {
    TripleSlash,
    DoubleSlashEM,
    SlashAsteriskEM,
    SlashAsteriskAsterisk,
    SlashAsterisk,
    MacroDocEqStr(String, usize),
    MacroDocEqMacro,
    CommonMark,
    DoubleSlash,
    SlashStar,
    Unknown,
    TomlEntry,
}

Expand description

Track what kind of comment the literal is

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.

`TripleSlash`

///

`DoubleSlashEM`

//!

`SlashAsteriskEM`

/*!

`SlashAsteriskAsterisk`

/**

`SlashAsterisk`

/*

`MacroDocEqStr(String, usize)`

#[doc= with actual prefix like #[doc= and the total length of r### etc. including r but without "

`MacroDocEqMacro`

#[doc= foo!(..)], content will be ignored, but allows clusters to not continue.

`CommonMark`

Commonmark File

`DoubleSlash`

Developer line comment

`SlashStar`

Developer block comment

`Unknown`

Unknown Variant

`TomlEntry`

Toml entry

Implementations

impl CommentVariant

pub fn category(&self) -> CommentVariantCategory

Obtain the comment variant category.

pub fn prefix_string(&self) -> String

Return the prefix string.

Does not include whitespaces for /// and //! variants!

pub fn prefix_len(&self) -> usize

Return length (in bytes) of comment prefix for each variant.

By definition matches the length of prefix_string.

pub fn suffix_len(&self) -> usize

Return suffix of different comment variants

pub fn suffix_string(&self) -> String

Return string which will be appended to each line

Trait Implementations

impl Clone for CommentVariant

fn clone(&self) -> CommentVariant

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for CommentVariant

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

Formats the value using the given formatter. Read more

impl Default for CommentVariant

fn default() -> Self

Returns the “default value” for a type. Read more

impl Hash for CommentVariant

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<CommentVariant> for CommentVariant

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

impl Eq for CommentVariant

impl StructuralEq for CommentVariant

impl StructuralPartialEq for CommentVariant

Auto Trait Implementations

impl RefUnwindSafe for CommentVariant

impl Send for CommentVariant

impl Sync for CommentVariant

impl Unpin for CommentVariant

impl UnwindSafe for CommentVariant

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for Twhere
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 Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.