Struct Tag 

pub struct Tag {
    pub rel_fname: String,
    pub fname: String,
    pub line: i32,
    pub name: String,
    pub kind: TagKind,
}

A tag extracted from source code (SPEC §2.1).

Field order is significant for derived PartialOrd/Ord: tags sort by (rel_fname, fname, line, name, kind).

Fields

rel_fname: String

Path relative to repository root (SPEC §2.2)

fname: String

Absolute path to file

line: i32

1-indexed line number, or -1 for fallback refs (SPEC §3.4)

name: String

The identifier text

kind: TagKind

Definition or reference

Implementations

impl Tag

pub fn new( rel_fname: impl Into<String>, fname: impl Into<String>, line: i32, name: impl Into<String>, kind: TagKind, ) -> Self

Create a new tag.

pub fn def( rel_fname: impl Into<String>, fname: impl Into<String>, line: i32, name: impl Into<String>, ) -> Self

Create a definition tag.

pub fn reference( rel_fname: impl Into<String>, fname: impl Into<String>, line: i32, name: impl Into<String>, ) -> Self

Create a reference tag.

pub fn is_def(&self) -> bool

Check if this is a definition tag.

pub fn is_ref(&self) -> bool

Check if this is a reference tag.

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tag

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Tag

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

Formats the value using the given formatter.

impl Eq for Tag

impl Hash for Tag

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 Ord for Tag

fn cmp(&self, other: &Tag) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Tag

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

fn partial_cmp(&self, other: &Tag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Tag

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tag