spor 0.3.0

Anchored metadata
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

use std::path::{Path, PathBuf};
use serde::{Serialize, Deserialize};
use std::marker::PhantomData;
use thiserror::Error;

mod check_path;
mod context;

use check_path::CheckPath;
pub use context::Context;

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Anchor_<PathType: CheckPath> {
    file_path: PathBuf,
    encoding: String,
    context: Context,
    metadata: serde_yaml::Value,
    check_path: PhantomData<PathType>
}


impl<PathType: CheckPath> Anchor_<PathType> {
    pub fn new(
        file_path: &Path,
        context: Context,
        metadata: serde_yaml::Value,
        encoding: String,
    ) -> Result<Anchor_<PathType>, AnchorError> {
        if let Some(msg) = PathType::check_path(file_path) {
            return Err(AnchorError::PathError(msg));
        }

        let anchor = Anchor_::<PathType> {
            file_path: PathBuf::from(file_path),
            encoding: encoding,
            context: context,
            metadata: metadata,
            check_path: PhantomData
        };

        Ok(anchor)
    }

    pub fn file_path(&self) -> &PathBuf {
        return &self.file_path;
    }

    pub fn encoding(&self) -> &String {
        return &self.encoding;
    }

    pub fn context(&self) -> &Context {
        return &self.context;
    }

    pub fn metadata(&self) -> &serde_yaml::Value {
        return &self.metadata;
    }
}

pub type Anchor = Anchor_::<check_path::AbsolutePath>;
pub type RelativeAnchor = Anchor_::<check_path::RelativePath>;

#[derive(Debug, Error)]
pub enum AnchorError {
    #[error("{0}")]
    PathError(String)
}