Enum CommentContext

pub enum CommentContext {
    Function {
        function_name: String,
    },
    Class {
        class_name: String,
    },
    Module,
    Inline,
    Block,
    Documentation,
}

Context for comments within code

Variants

Function

Comment associated with a function

Fields

function_name: String

Name of the function this comment describes

Class

Comment associated with a class

Fields

class_name: String

Name of the class this comment describes

Module

Comment associated with a module/file

Inline

Inline comment

Block

Block comment

Documentation

Documentation comment (e.g., JSDoc, Python docstring)

Trait Implementations

impl Clone for CommentContext

fn clone(&self) -> CommentContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommentContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommentContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CommentContext

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CommentContext

fn eq(&self, other: &CommentContext) -> 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 Serialize for CommentContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CommentContext

impl StructuralPartialEq for CommentContext