Skip to main content

ReferenceStyle

Struct ReferenceStyle 

Source
pub struct ReferenceStyle {
    pub wrapper: Wrapper,
    pub addressing: Addressing,
    pub label: bool,
    pub path_style: LinkStyle,
}
Expand description

How a durable reference is spelled: a Wrapper, an Addressing, whether an id link carries a title label, and the path rendering used when addressing by path. This is the per-workspace default and the per-relation override (see crate::relation::Relation::style).

Fields§

§wrapper: Wrapper

The syntactic wrapper.

§addressing: Addressing

What the reference addresses its target by.

§label: bool

Whether an id wikilink carries a |Title label (a maintained cache of the target’s title). Ignored for markdown (its [Title] is intrinsic) and for alias (the target string is the title).

§path_style: LinkStyle

Path rendering for Addressing::Path — ignored otherwise.

Implementations§

Source§

impl ReferenceStyle

Source

pub fn normalized(self) -> Self

Normalize impossible combinations: alias has no markdown spelling (there is no locator to put in [Title](…)), so a markdown+alias request becomes wikilink+alias.

Source

pub fn registers(self) -> bool

Whether authoring in this style is a link-by-id — the trigger that registers the target. Only id addressing registers.

Trait Implementations§

Source§

impl Clone for ReferenceStyle

Source§

fn clone(&self) -> ReferenceStyle

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 ReferenceStyle

Source§

impl Debug for ReferenceStyle

Source§

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

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

impl Default for ReferenceStyle

Source§

fn default() -> Self

Markdown path links in the default LinkStyle — the pre-existing behavior, so an unconfigured workspace is unchanged.

Source§

impl Eq for ReferenceStyle

Source§

impl PartialEq for ReferenceStyle

Source§

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

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.