Enum DocFragmentKind 

pub enum DocFragmentKind {
    Sugared(CommentKind),
    Raw(Span),
}

Represents the kind of doc comment it is, ie /// or #[doc = ""].

Variants

Sugared(CommentKind)

A sugared doc comment: /// or //! or /** or /*!.

Raw(Span)

A “raw” doc comment: #[doc = ""]. The Span represents the string literal.

Implementations

impl DocFragmentKind

pub fn is_sugared(self) -> bool

pub fn comment_kind(self) -> CommentKind

If it is Sugared, it will return its associated CommentKind, otherwise it will return CommentKind::Line.

Trait Implementations

impl Clone for DocFragmentKind

fn clone(&self) -> DocFragmentKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocFragmentKind

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

Formats the value using the given formatter.

impl<__D: SpanDecoder> Decodable<__D> for DocFragmentKind

fn decode(__decoder: &mut __D) -> Self

impl<__E: SpanEncoder> Encodable<__E> for DocFragmentKind

fn encode(&self, __encoder: &mut __E)

impl<__CTX> HashStable<__CTX> for DocFragmentKind

where __CTX: HashStableContext,

fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)

impl PartialEq for DocFragmentKind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DocFragmentKind

impl Eq for DocFragmentKind

impl StructuralPartialEq for DocFragmentKind

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 12 bytes

Size for each variant:

• Sugared: 1 byte
• Raw: 11 bytes