Skip to main content

Notation

Enum Notation 

Source
pub enum Notation {
    Markdown,
    Wikilink,
    Bare,
}
Expand description

The syntactic form a reference is written in — the config-facing notation axis (references.notation), orthogonal to PathStyle. This is the clean split of what the internal Wrapper + plain_/markdown_ LinkStyle prefix fused: Bare is a path with no brackets, Markdown is [Title](…), Wikilink is [[…]].

Variants§

§

Markdown

[Title](target).

[[target]] / [[target|Title]].

§

Bare

A bare target, no brackets — what the old plain_* link formats wrote.

Implementations§

Source§

impl Notation

Source

pub fn from_config_str(value: &str) -> Option<Self>

Parse the references.notation config spelling; unknown → None.

Source

pub fn as_config_str(self) -> &'static str

The references.notation config spelling.

Source

pub fn wrapper(self) -> Wrapper

The internal Wrapper this notation renders through. Markdown and Bare share the Markdown wrapper (the bracket-vs-bare choice lives in the path style); Wikilink is its own wrapper.

Source

pub fn from_wrapper(wrapper: Wrapper, style: LinkStyle) -> Self

Recover the notation from a fused Wrapper + LinkStyle — the inverse direction, for serializing an internal style back to config.

Trait Implementations§

Source§

impl Clone for Notation

Source§

fn clone(&self) -> Notation

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 Copy for Notation

Source§

impl Debug for Notation

Source§

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

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

impl Default for Notation

Source§

fn default() -> Notation

Returns the “default value” for a type. Read more
Source§

impl Eq for Notation

Source§

impl PartialEq for Notation

Source§

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

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.