gravityfile-ops 0.4.1

File operations engine for gravityfile
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

//! Per-path operation diagnostics.

use std::path::PathBuf;

use serde::{Deserialize, Serialize};

/// A problem with one path during an operation.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct OperationError {
    pub path: PathBuf,
    pub message: String,
    /// When nonzero, this record stands in for that many omitted diagnostics.
    #[serde(default)]
    pub omitted_count: usize,
}

impl OperationError {
    pub fn new(path: PathBuf, message: impl Into<String>) -> Self {
        Self {
            path,
            message: message.into(),
            omitted_count: 0,
        }
    }

    /// Number of diagnostics this record represents.
    pub fn represented_count(&self) -> usize {
        self.omitted_count.max(1)
    }

    pub(crate) fn omitted(count: usize) -> Self {
        Self {
            path: PathBuf::new(),
            message: format!("{count} more problem(s) not listed"),
            omitted_count: count,
        }
    }
}

impl std::fmt::Display for OperationError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        if self.path.as_os_str().is_empty() {
            f.write_str(&self.message)
        } else {
            write!(f, "{}: {}", self.path.display(), self.message)
        }
    }
}