Struct CrossReference 

#[non_exhaustive]
pub struct CrossReference {
    pub target: String,
    pub text: Option<String>,
    pub location: Location,
}

A CrossReference represents an inline cross-reference (xref) in a document.

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.

target: String

text: Option<String>

location: Location

Implementations

impl CrossReference

pub fn new(target: impl Into<String>, location: Location) -> Self

Creates a new CrossReference with the given target.

pub fn with_text(self, text: Option<String>) -> Self

Sets the cross-reference display text.

Trait Implementations

impl Clone for CrossReference

fn clone(&self) -> CrossReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CrossReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CrossReference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CrossReference

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

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 CrossReference