obsidian-parser 0.9.4

Blazingly fast Obsidian vault parser with graph analysis
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

//! Options for [`VaultBuilder`] and [`Vault`]
//!
//! [`VaultBuilder`]: crate::vault::vault_open::VaultBuilder
//! [`Vault`]: crate::vault::Vault

use std::path::{Path, PathBuf};

/// Options for [`VaultBuilder`] and [`Vault`]
///
/// [`VaultBuilder`]: crate::vault::vault_open::VaultBuilder
/// [`Vault`]: crate::vault::Vault
#[derive(Debug, PartialEq, Eq, Clone)]
pub struct VaultOptions {
    /// Path to vault
    path: PathBuf,
}

impl VaultOptions {
    /// Create new [`VaultOptions`]
    pub fn new(path: impl AsRef<Path>) -> Self {
        Self {
            path: path.as_ref().to_path_buf(),
        }
    }

    /// Get path to vault
    #[inline]
    #[must_use]
    pub fn path(&self) -> &Path {
        &self.path
    }

    /// Get into path to vault
    #[inline]
    #[must_use]
    pub fn into_path(self) -> PathBuf {
        self.path
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[cfg_attr(feature = "tracing", tracing_test::traced_test)]
    #[test]
    fn new() {
        let path = PathBuf::from("path/to/vault");
        let options = VaultOptions::new(&path);

        assert_eq!(options.path, path);
        assert_eq!(options.path(), path);
    }
}