Struct ConstantMetadata 

#[non_exhaustive]
pub struct ConstantMetadata {
    pub attributes: Vec<AttributeMetadata>,
    pub name: Atom,
    pub span: Span,
    pub type_metadata: Option<TypeMetadata>,
    pub inferred_type: Option<TUnion>,
    pub flags: MetadataFlags,
    pub issues: Vec<Issue>,
}

Contains metadata associated with a global constant defined using const.

Represents a single constant declaration item, potentially within a grouped declaration, like MAX_RETRIES = 3 in const MAX_RETRIES = 3; or B = 2 in const A = 1, B = 2;.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

attributes: Vec<AttributeMetadata>

name: Atom

span: Span

type_metadata: Option<TypeMetadata>

inferred_type: Option<TUnion>

flags: MetadataFlags

issues: Vec<Issue>

Implementations

impl ConstantMetadata

pub fn new(name: Atom, span: Span, flags: MetadataFlags) -> Self

Creates new ConstantMetadata for a non-deprecated, non-internal global constant item.

Arguments

• name: The identifier (name) of the constant.
• span: The source code location of this specific constant’s definition item (NAME = value).

pub fn take_issues(&mut self) -> Vec<Issue>

Returns a mutable slice of docblock issues.

Trait Implementations

impl Clone for ConstantMetadata

fn clone(&self) -> ConstantMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConstantMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConstantMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasSpan for ConstantMetadata

fn span(&self) -> Span

Returns the source span.

fn start_position(&self) -> Position

A convenience method to get the starting position of the span.

fn start_offset(&self) -> u32

A convenience method to get the starting byte offset of the span.

fn end_position(&self) -> Position

A convenience method to get the ending position of the span.

fn end_offset(&self) -> u32

A convenience method to get the ending byte offset of the span.

impl PartialEq for ConstantMetadata

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

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 ConstantMetadata

impl StructuralPartialEq for ConstantMetadata