Enum RefContext 

pub enum RefContext {
    Body,
    TypeAttribute,
    OtherAttribute,
    AttributeString,
}

Where in the source a reference was extracted from. The same textual mod:ident(...) shape means a function call in body context and a type reference in type-attribute context, so the extractor must carry the surrounding context with each symbol it emits.

Variants

Body

Inside a function body or top-level expression.

TypeAttribute

Inside a -spec, -callback, -type, or -opaque attribute, where mod:ident(...) is a type reference, not a function call.

OtherAttribute

Inside any other attribute form (-export, -define, -record, …), where an identifier is never a local call.

AttributeString

Inside a multi-line string in an attribute, such as the documentation prose of -moduledoc """ ... """. Every byte is string content, so nothing here is a reference of any kind.

Implementations

impl RefContext

pub fn is_attribute(self) -> bool

True in any attribute region; a local name( there is a type name, an export entry, a macro parameter, or string content, never a call or a clause head.

pub fn holds_calls(self) -> bool

True where mod:fun(...) may be a real call. False in type attributes, where it names a type, and in attribute strings, where a documentation example is not a call the patch adds.

Trait Implementations

impl Clone for RefContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RefContext

impl Debug for RefContext

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

Formats the value using the given formatter.

impl Eq for RefContext

impl Hash for RefContext

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 RefContext

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RefContext