Struct SourceFacet 

pub struct SourceFacet {
    pub origin: SourceOrigin,
    pub span: Option<ByteSpan>,
    pub macro_chain: Vec<MacroExpansion>,
    pub doc_comments: Vec<String>,
}

Provenance, always present on every node.

A node created programmatically records a synthetic origin rather than none, so “where did this come from” always has an answer. Spec §4.7.

Fields

origin: SourceOrigin

Where the node came from.

span: Option<ByteSpan>

Byte range in the source file, when there is one.

macro_chain: Vec<MacroExpansion>

Preprocessor expansions that produced this construct, outermost first.

doc_comments: Vec<String>

Documentation comments attached to the declaration.

Implementations

impl SourceFacet

pub fn synthetic(reason: &str) -> Self

Provenance for a programmatically created node.

pub const fn builtin() -> Self

Provenance for a built-in declaration.

pub fn file(path: String, span: Option<ByteSpan>) -> Self

Provenance for a node parsed from a file.

pub const fn is_from_file(&self) -> bool

Whether the node came from parsed source text.

Trait Implementations

impl Clone for SourceFacet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceFacet

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

Formats the value using the given formatter.

impl Default for SourceFacet

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SourceFacet

impl PartialEq for SourceFacet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SourceFacet