ferriki 0.5.0

Reusable native Rust syntax highlighter with TextMate grammars
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

//! Content-addressed asset sources. Verification belongs to the catalog, so
//! custom sources cannot accidentally bypass the release integrity contract.

use std::borrow::Cow;
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use std::str::FromStr;

use ferriki_asset_gen::FORMAT_VERSION;
use sha2::{Digest, Sha256};

use crate::{Error, ErrorKind, Result};

/// A normalized SHA-256 digest; safe to use as a cache filename.
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct AssetDigest(String);

impl AssetDigest {
    pub fn of(bytes: &[u8]) -> Self {
        Self(format!("{:x}", Sha256::digest(bytes)))
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }
}

impl FromStr for AssetDigest {
    type Err = Error;

    fn from_str(value: &str) -> Result<Self> {
        if value.len() != 64 || !value.bytes().all(|byte| byte.is_ascii_hexdigit()) {
            return Err(Error::new(
                ErrorKind::AssetFormat,
                "An asset digest must contain 64 hexadecimal SHA-256 digits.",
            ));
        }
        Ok(Self(value.to_ascii_lowercase()))
    }
}

/// Release-pinned integrity information for one payload.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct AssetMetadata {
    digest: AssetDigest,
    size: u64,
    format_version: u32,
}

impl AssetMetadata {
    pub fn new(digest: AssetDigest, size: u64, format_version: u32) -> Self {
        Self {
            digest,
            size,
            format_version,
        }
    }

    pub fn digest(&self) -> &AssetDigest {
        &self.digest
    }
    pub fn size(&self) -> u64 {
        self.size
    }
    pub fn format_version(&self) -> u32 {
        self.format_version
    }

    pub(crate) fn validate_format(&self) -> Result<()> {
        if self.format_version != FORMAT_VERSION {
            return Err(Error::new(
                ErrorKind::AssetFormat,
                format!(
                    "Unsupported asset format {}; expected {FORMAT_VERSION}.",
                    self.format_version
                ),
            ));
        }
        Ok(())
    }

    pub(crate) fn verify(&self, bytes: &[u8]) -> Result<()> {
        self.validate_format()?;
        if bytes.len() as u64 != self.size || AssetDigest::of(bytes) != self.digest {
            return Err(Error::new(
                ErrorKind::AssetIntegrity,
                format!(
                    "Asset {} failed its SHA-256 or byte-size check.",
                    self.digest.as_str()
                ),
            ));
        }
        Ok(())
    }
}

/// Supplies immutable asset bytes by digest. Sources may perform synchronous
/// I/O while explicitly loading assets; they must not implement retries here.
/// Catalogs verify returned bytes before decoding or retaining them.
pub trait AssetSource: Send + Sync {
    fn read(&self, digest: &AssetDigest) -> Result<Cow<'_, [u8]>>;
}

/// Reads a digest-addressed directory, such as a pre-populated offline cache.
#[derive(Clone, Debug)]
pub struct DirectoryAssetSource {
    root: PathBuf,
}

impl DirectoryAssetSource {
    pub fn new(root: impl Into<PathBuf>) -> Self {
        Self { root: root.into() }
    }
    pub fn root(&self) -> &Path {
        &self.root
    }
}

impl AssetSource for DirectoryAssetSource {
    fn read(&self, digest: &AssetDigest) -> Result<Cow<'_, [u8]>> {
        std::fs::read(self.root.join(digest.as_str())).map(Cow::Owned).map_err(|source| {
            let kind = if source.kind() == std::io::ErrorKind::NotFound {
                ErrorKind::AssetUnavailable
            } else { ErrorKind::AssetIo };
            Error::new(kind, format!("Cannot read asset {} from {}. Pre-populate the cache or provide an embedded asset source.", digest.as_str(), self.root.display())).with_source(source)
        })
    }
}

/// Borrowed or owned offline payloads, deduplicated by digest.
#[derive(Default)]
pub struct EmbeddedAssetSource {
    assets: HashMap<AssetDigest, Cow<'static, [u8]>>,
}

impl EmbeddedAssetSource {
    pub fn new(assets: impl IntoIterator<Item = (AssetDigest, Cow<'static, [u8]>)>) -> Self {
        Self {
            assets: assets.into_iter().collect(),
        }
    }
}

impl AssetSource for EmbeddedAssetSource {
    fn read(&self, digest: &AssetDigest) -> Result<Cow<'_, [u8]>> {
        self.assets.get(digest).map(|bytes| Cow::Borrowed(bytes.as_ref())).ok_or_else(|| {
            Error::new(ErrorKind::AssetUnavailable, format!(
                "Asset {} is unavailable offline. Provide embedded bytes or a pre-populated cache.", digest.as_str()
            ))
        })
    }
}