Struct vimwiki::lang::components::WikiLink

pub struct WikiLink {
    pub path: PathBuf,
    pub description: Option<Description>,
    pub anchor: Option<Anchor>,
}

Represents a link to a file or directory in the active wiki

Fields

path: PathBuf

description: Option<Description>

anchor: Option<Anchor>

Implementations

impl WikiLink

pub fn new(
    path: PathBuf,
    description: Option<Description>,
    anchor: Option<Anchor>
) -> WikiLink

impl WikiLink

pub fn is_local_anchor(&self) -> bool

Whether or not the link is representing an anchor to the current page

pub fn is_path_dir(&self) -> bool

Checks if the link's path is to a directory without actually evaluating in the filesystem. Only checks if the path appears as that of a directory

Trait Implementations

impl Clone for WikiLink

fn clone(&self) -> WikiLink

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WikiLink

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

Formats the value using the given formatter.

impl Default for WikiLink

fn default() -> WikiLink

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for WikiLink

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

Deserialize this value from the given Serde deserializer.

impl Eq for WikiLink

impl From<PathBuf> for WikiLink

fn from(path: PathBuf) -> Self

Performs the conversion.

impl From<String> for WikiLink

fn from(str_path: String) -> Self

Performs the conversion.

impl From<WikiLink> for Link

fn from(original: WikiLink) -> Link

Performs the conversion.

impl Hash for WikiLink

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 PartialEq<WikiLink> for WikiLink

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

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

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

This method tests for !=.

impl Serialize for WikiLink

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for WikiLink

impl StructuralPartialEq for WikiLink