vimwiki 0.1.0-alpha.2

Library that provides support to parse, generate, and manipulate vimwiki langauge.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use super::{Anchor, Description, WikiLink};
use derive_more::{Constructor, Display, From};
use serde::{Deserialize, Serialize};
use std::{fmt, path::Path};

/// Represents a link to a file or directory in another wiki
#[derive(
    Clone, Debug, Display, From, Eq, PartialEq, Hash, Serialize, Deserialize,
)]
pub enum InterWikiLink {
    Indexed(IndexedInterWikiLink),
    Named(NamedInterWikiLink),
}

impl InterWikiLink {
    /// Returns the index associated with this interwiki link if it is an
    /// indexed interwiki link
    pub fn index(&self) -> Option<u32> {
        match self {
            Self::Indexed(x) => Some(x.index),
            _ => None,
        }
    }

    /// Returns the name associated with this interwiki link if it is a
    /// named interwiki link
    pub fn name(&self) -> Option<&str> {
        match self {
            Self::Named(x) => Some(&x.name),
            _ => None,
        }
    }

    pub fn link(&self) -> &WikiLink {
        match self {
            Self::Indexed(x) => &x.link,
            Self::Named(x) => &x.link,
        }
    }

    pub fn path(&self) -> &Path {
        &self.link().path
    }

    pub fn description(&self) -> Option<&Description> {
        self.link().description.as_ref()
    }

    pub fn anchor(&self) -> Option<&Anchor> {
        self.link().anchor.as_ref()
    }
}

/// Represents a link to a file or directory in another wiki specified by
/// an index that maps to the g:vimwiki_list
#[derive(
    Constructor, Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize,
)]
pub struct IndexedInterWikiLink {
    pub index: u32,
    pub link: WikiLink,
}

impl fmt::Display for IndexedInterWikiLink {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.link)
    }
}

impl From<(u32, WikiLink)> for IndexedInterWikiLink {
    fn from((index, link): (u32, WikiLink)) -> Self {
        Self::new(index, link)
    }
}

/// Represents a link to a file or directory in another wiki specified by
/// a name that maps to the name key in g:vimwiki_list
#[derive(
    Constructor, Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize,
)]
pub struct NamedInterWikiLink {
    pub name: String,
    pub link: WikiLink,
}

impl fmt::Display for NamedInterWikiLink {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.link)
    }
}

impl From<(String, WikiLink)> for NamedInterWikiLink {
    fn from((name, link): (String, WikiLink)) -> Self {
        Self::new(name, link)
    }
}