Struct CommentLinkToken

pub struct CommentLinkToken {
    pub label: String,
    pub path: Option<String>,
    pub resolved_item: Option<DocumentableItemId>,
}

Token representing a link to another item inside the documentation.

Fields

label: String

A link part that’s inside “[]” brackets.

path: Option<String>

A link part that’s inside “()” brackets, right after the label.

resolved_item: Option<DocumentableItemId>

Item resolved based on the path provided by user. If resolver cannot resolve the item, we leave it as None.

Trait Implementations

impl Clone for CommentLinkToken

fn clone(&self) -> CommentLinkToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommentLinkToken

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

Formats the value using the given formatter.

impl DebugWithDb<dyn DocGroup> for CommentLinkToken

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

fn debug<'me, 'db>(&'me self, db: &'me Db) -> DebugWith<'me, Db>

where Self: Sized + 'me,

fn into_debug<'me, 'db>(self, db: &'me Db) -> DebugWith<'me, Db>

where Self: Sized + 'me,

impl Display for CommentLinkToken

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

Formats the value using the given formatter.

impl PartialEq for CommentLinkToken

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

impl StructuralPartialEq for CommentLinkToken