snipdoc 0.1.12

Code Documentation Made Simple
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

mod code;
mod yaml;

use std::collections::BTreeMap;

use crate::parser::{collector::CollectSnippet, Snippet, SnippetTemplate};
pub use code::Code;
use lazy_static::lazy_static;
use serde::{Deserialize, Serialize};
pub use yaml::{Yaml, DEFAULT_FILE_NAME};

lazy_static! {
    pub static ref EMPTY_COLLECTED_SNIPPETS: Vec<CollectSnippet> = vec![CollectSnippet {
        id: "SNIPPET_ID".to_string(),
        inject_from: None,
        tag_open: String::new(),
        tag_close: String::new(),
        snippet: vec![String::new()],
    }];
    pub static ref EMPTY_TEMPLATE_SNIPPETS: BTreeMap<String, SnippetTemplate> = BTreeMap::from([(
        "TEMPLATE_ID".to_string(),
        SnippetTemplate {
            content: r"```sh
{snippet}
```"
            .to_string(),
        }
    )]);
}

/// A trait that defines the behavior for database operations.
pub trait Db {
    /// Loads data from the database.
    ///
    /// # Returns
    ///
    /// A [`Result`] containing the loaded `DBData` on success, or an [`Error`]
    /// on failure.
    ///
    /// # Errors
    ///
    /// Return and [`Error`] when could not load the data
    fn load(&self) -> Result<'_, DBData>;

    /// Saves a list of snippets to the database.
    ///
    ///
    /// # Returns
    ///
    /// A `Result` indicating success or failure.
    ///
    /// # Errors
    ///
    /// Return and [`Error`] when could not save the data
    fn save(&self, _: &[&CollectSnippet], _: &BTreeMap<String, SnippetTemplate>) -> Result<'_, ()> {
        Err(Error::NotSupported)
    }
}

#[derive(Default, Serialize, Deserialize, Debug)]
pub struct DBData {
    pub snippets: BTreeMap<String, Snippet>,
    pub templates: BTreeMap<String, SnippetTemplate>,
}

#[derive(thiserror::Error, Debug)]
pub enum Error {
    #[error(transparent)]
    IO(#[from] std::io::Error),

    #[error(transparent)]
    YAML(#[from] serde_yaml::Error),

    #[error("operation not supported")]
    NotSupported,
}

pub type Result<'a, T> = std::result::Result<T, Error>;