Skip to main content

ReferenceType

Enum ReferenceType 

Source
pub enum ReferenceType {
    ToCome {
        identifier: Option<String>,
    },
    Citation(CitationData),
    AnnotationReference {
        label: String,
    },
    FootnoteNumber {
        number: u32,
    },
    Session {
        target: String,
    },
    Url {
        target: String,
    },
    File {
        target: String,
    },
    General {
        target: String,
    },
    NotSure,
}
Expand description

Reference type classification derived from its content.

Variants§

§

ToCome

[TK] or [TK-identifier]

Fields

§identifier: Option<String>
§

Citation(CitationData)

[@citation] with structured citation data.

§

AnnotationReference

[::note] — pointer to an annotation by label.

Fields

§label: String
§

FootnoteNumber

[12]

Fields

§number: u32
§

Session

[#42]

Fields

§target: String
§

Url

[https://example.com]

Fields

§target: String
§

File

[./file.txt]

Fields

§target: String
§

General

[Introduction] or other document references.

Fields

§target: String
§

NotSure

Unable to classify.

Implementations§

Source§

impl ReferenceType

Source

pub fn anchoring(&self) -> AnchorKind

Classify this reference type’s anchoring capability, per §2.3.4.

Link-like types (Url, File, Session, General) render as a span of linked text and are therefore AnchorKind::WholeLineCapable. Marker-style types (FootnoteNumber, Citation, AnnotationReference) render as markers/superscripts and are AnchorKind::MarkerOnly. The unclassified placeholders (ToCome, NotSure) are treated as MarkerOnly: a [TK] placeholder has no destination to link and an unclassifiable reference must not silently consume a whole element.

Trait Implementations§

Source§

impl Clone for ReferenceType

Source§

fn clone(&self) -> ReferenceType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ReferenceType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ReferenceType

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ReferenceType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more