Enum vimwiki_core::Link

pub enum Link<'a> {
    Wiki {
        data: LinkData<'a>,
    },
    IndexedInterWiki {
        index: u32,
        data: LinkData<'a>,
    },
    NamedInterWiki {
        name: Cow<'a, str>,
        data: LinkData<'a>,
    },
    Diary {
        date: NaiveDate,
        data: LinkData<'a>,
    },
    Raw {
        data: LinkData<'a>,
    },
    Transclusion {
        data: LinkData<'a>,
    },
}

Represents some kind of link in a document

Variants

Wiki

Represents a traditional link within a wiki

Fields of Wiki

data: LinkData<'a>

IndexedInterWiki

Represents a link to another wiki referenced by its index

Fields of IndexedInterWiki

index: u32data: LinkData<'a>

NamedInterWiki

Represents a link to another wiki referenced by its name

Fields of NamedInterWiki

name: Cow<'a, str>data: LinkData<'a>

Diary

Represents a link to a diary entry within a wiki

Fields of Diary

date: NaiveDatedata: LinkData<'a>

Raw

Represents a raw link without any frills (should only have URI)

Fields of Raw

data: LinkData<'a>

Transclusion

Represents a transclusion link that is used to pull in the content referenced by the URI

Fields of Transclusion

data: LinkData<'a>

Implementations

impl<'a> Link<'a>

pub fn is_wiki(&self) -> bool

pub fn is_indexed_inter_wiki(&self) -> bool

pub fn is_named_inter_wiki(&self) -> bool

pub fn is_diary(&self) -> bool

pub fn is_raw(&self) -> bool

pub fn is_transclusion(&self) -> bool

impl<'a> Link<'a>

pub fn new_wiki_link<U: Into<URIReference<'a>>, D: Into<Option<Description<'a>>>>(
    uri_ref: U,
    description: D
) -> Self

Creates a new wiki link

pub fn try_new_wiki_link<U: TryInto<URIReference<'a>, Error = URIReferenceError>, D: Into<Option<Description<'a>>>>(
    uri_ref: U,
    description: D
) -> Result<Self, URIReferenceError>

Tries to create a new wiki link

pub fn new_indexed_interwiki_link<U: Into<URIReference<'a>>, D: Into<Option<Description<'a>>>>(
    index: u32,
    uri_ref: U,
    description: D
) -> Self

Creates a new indexed interwiki link

pub fn try_new_indexed_interwiki_link<U: TryInto<URIReference<'a>, Error = URIReferenceError>, D: Into<Option<Description<'a>>>>(
    index: u32,
    uri_ref: U,
    description: D
) -> Result<Self, URIReferenceError>

Tries to create a new indexed interwiki link

pub fn new_named_interwiki_link<S: Into<Cow<'a, str>>, U: Into<URIReference<'a>>, D: Into<Option<Description<'a>>>>(
    name: S,
    uri_ref: U,
    description: D
) -> Self

Creates a new named interwiki link

pub fn try_new_named_interwiki_link<S: Into<Cow<'a, str>>, U: TryInto<URIReference<'a>, Error = URIReferenceError>, D: Into<Option<Description<'a>>>>(
    name: S,
    uri_ref: U,
    description: D
) -> Result<Self, URIReferenceError>

Trys to create a new named interwiki link

pub fn new_diary_link<D: Into<Option<Description<'a>>>, A: Into<Option<Anchor<'a>>>>(
    date: NaiveDate,
    description: D,
    anchor: A
) -> Self

Creates a new diary link

pub fn new_raw_link<U: Into<URIReference<'a>>>(uri_ref: U) -> Self

Creates a new raw link

pub fn try_new_raw_link<U: TryInto<URIReference<'a>, Error = URIReferenceError>>(
    uri_ref: U
) -> Result<Self, URIReferenceError>

Tries to create a new raw link

pub fn new_transclusion_link<U: Into<URIReference<'a>>, D: Into<Option<Description<'a>>>, P: Into<Option<HashMap<Cow<'a, str>, Cow<'a, str>>>>>(
    uri_ref: U,
    description: D,
    properties: P
) -> Self

Creates a new transclusion link

pub fn try_new_transclusion_link<U: TryInto<URIReference<'a>, Error = URIReferenceError>, D: Into<Option<Description<'a>>>, P: Into<Option<HashMap<Cow<'a, str>, Cow<'a, str>>>>>(
    uri_ref: U,
    description: D,
    properties: P
) -> Result<Self, URIReferenceError>

Tries to create a new transclusion link

pub fn data(&self) -> &LinkData<'a>

Returns reference to data associated with link

pub fn into_data(self) -> LinkData<'a>

Consumes link and returns data associated with link

pub fn description(&self) -> Option<&Description<'a>>

Returns reference to description associated with link

pub fn into_description(self) -> Option<Description<'a>>

Consumes link and returns the description associated with link

pub fn to_description_or_fallback(&self) -> Option<Description<'a>>

Produces a description based on the link, either using the description associated with the link or falling back to the link’s URI after applying percent decoding (not for raw or transclusion links)

pub fn properties(&self) -> Option<&HashMap<Cow<'a, str>, Cow<'a, str>>>

Returns reference to the properties associated with link

pub fn into_properties(self) -> Option<HashMap<Cow<'a, str>, Cow<'a, str>>>

Consumes link and returns the properties associated with link

pub fn has_anchor(&self) -> bool

Returns true if link contains an anchor

pub fn to_anchor(&self) -> Option<Anchor<'_>>

Creates anchor based on link’s uri fragment if it exists

pub fn scheme(&self) -> Option<&Scheme<'_>>

Returns reference to the scheme of the link’s uri if it exists

pub fn date(&self) -> Option<NaiveDate>

Returns a copy of the date associated with the link if it exists (only occurs when is a diary link)

pub fn index(&self) -> Option<u32>

Returns a copy of the index associated with the link if it exist (only occurs when is an indexed interwiki link)

pub fn name(&self) -> Option<&str>

Returns a reference to the name associated with the link if it exists (only occurs when is a named interwiki link)

impl Link<'_>

pub fn to_borrowed(&self) -> Link<'_>

pub fn into_owned(self) -> Link<'static>

Trait Implementations

impl<'a> Clone for Link<'a>

fn clone(&self) -> Link<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Link<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Link<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> Display for Link<'a>

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

Formats the value using the given formatter.

impl<'a> From<Link<'a>> for DecoratedTextContent<'a>

fn from(original: Link<'a>) -> DecoratedTextContent<'a>

Performs the conversion.

impl<'a> From<Link<'a>> for InlineElement<'a>

fn from(original: Link<'a>) -> InlineElement<'a>

Performs the conversion.

impl<'a> From<Link<'a>> for Element<'a>

fn from(value: Link<'a>) -> Self

Performs the conversion.

impl<'a> Hash for Link<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<Link<'a>> for Link<'a>

fn eq(&self, other: &Link<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Link<'a>) -> bool

This method tests for !=.

impl<'a> Serialize for Link<'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> StrictEq<Link<'a>> for Link<'a>

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

Performs strict_eq check on matching inner variants

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

impl<'a> Eq for Link<'a>

impl<'a> StructuralEq for Link<'a>

impl<'a> StructuralPartialEq for Link<'a>