Struct Anchor 

#[non_exhaustive]
pub struct Anchor<'a> {
    pub id: &'a str,
    pub xreflabel: Option<&'a str>,
    pub location: Location,
    /* private fields */
}

An Anchor represents an anchor in a document.

An anchor is a reference point in a document that can be linked to.

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.

id: &'a str

xreflabel: Option<&'a str>

location: Location

Implementations

impl<'a> Anchor<'a>

pub fn new(id: &'a str, location: Location) -> Self

Create a new anchor with the given ID and location.

pub fn with_xreflabel(self, xreflabel: Option<&'a str>) -> Self

Set the cross-reference label.

pub fn is_bibliography(&self) -> bool

Returns whether this anchor identifies a bibliography entry.

pub fn bibliography_label(&self) -> Option<&[InlineNode<'a>]>

Return the entry label after its source-position inline substitutions.

Citation text remains separate in Self::xreflabel. Returns None for ordinary anchors and entries that use their ID as the label.

Trait Implementations

impl<'a> Clone for Anchor<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Anchor<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Anchor<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq for Anchor<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> Serialize for Anchor<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for Anchor<'a>