vimwiki-core 0.1.0

Core library elements for vimwiki data structures, parsing, and more
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

mod errors;
mod span;
mod utils;

/// Vimwiki-specific parsers
pub mod vimwiki;

/// Export the span used for input
pub use span::Span;

/// Alias to the type of error to use with parsing using nom
pub use errors::LangParserError as Error;

/// Alias to an Result using our custom error and span
pub type IResult<'a, O> = Result<(Span<'a>, O), nom::Err<Error<'a>>>;

/// Represents some data captured with the input used to create it
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct Captured<'a, T> {
    inner: T,
    input: Span<'a>,
}

impl<'a, T> Captured<'a, T> {
    pub fn new(inner: T, input: Span<'a>) -> Self {
        Self { inner, input }
    }

    pub fn into_inner(self) -> T {
        self.inner
    }

    /// Represents the input that was used to construct the data
    pub fn input(&self) -> Span<'a> {
        self.input
    }
}