buffrs 0.13.0

Modern protobuf package management
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 std::path::{Path, PathBuf};

use miette::{Context, IntoDiagnostic};
use tokio::fs;

use crate::errors::FileExistsError;

/// The `File` trait standardizes the process of reading and writing files.
#[async_trait::async_trait]
pub trait File: Sized + Send + Sync + 'static {
    /// The default location of this file
    const DEFAULT_PATH: &str;

    /// Resolves a path to the concrete file location
    fn resolve<P>(path: P) -> miette::Result<PathBuf>
    where
        P: AsRef<Path> + Send + Sync,
    {
        let path = path.as_ref();

        if path.is_file() {
            return Ok(path.to_path_buf());
        }

        if path.is_dir() {
            return Ok(path.join(Self::DEFAULT_PATH));
        }

        let parent = path.parent().ok_or(miette::miette!(
            "Parent not resolvable for {}",
            path.display()
        ))?;

        Ok(parent.join(Self::DEFAULT_PATH))
    }

    /// Checks if the file currently exists in the filesystem at its default path
    async fn exists() -> miette::Result<bool> {
        Self::exists_at(Self::DEFAULT_PATH).await
    }

    /// Checks if the file currently exists in the filesystem at a given path
    async fn exists_at<P>(path: P) -> miette::Result<bool>
    where
        P: AsRef<Path> + Send + Sync,
    {
        let resolved = Self::resolve(path)?;

        fs::try_exists(resolved)
            .await
            .into_diagnostic()
            .wrap_err(FileExistsError(Self::DEFAULT_PATH))
    }

    /// Loads the file from the current directory
    async fn load() -> miette::Result<Self> {
        Self::load_from(Self::DEFAULT_PATH).await
    }

    /// Loads the file from a specific path.
    async fn load_from<P>(path: P) -> miette::Result<Self>
    where
        P: AsRef<Path> + Send + Sync;

    /// Loads the file from the current directory, if it exists, otherwise returns an empty one. Fails, if the exists() check fails
    async fn load_or_default() -> miette::Result<Self>
    where
        Self: Default,
    {
        if Self::exists().await? {
            Self::load().await
        } else {
            Ok(Self::default())
        }
    }

    /// Loads the file from a specific path, if it exists, otherwise returns an empty one. Fails, if the exists() check fails
    async fn load_from_or_default<P>(path: P) -> miette::Result<Self>
    where
        Self: Default,
        P: AsRef<Path> + Send + Sync,
    {
        let resolved = Self::resolve(path)?;

        if Self::exists_at(&resolved).await? {
            Self::load_from(resolved).await
        } else {
            Ok(Self::default())
        }
    }

    /// Persists a file to the filesystem.
    async fn save_to<P>(&self, path: P) -> miette::Result<()>
    where
        P: AsRef<Path> + Send + Sync;
}