phoxal 0.67.0

Phoxal - production-oriented autonomous robot framework: the one framework library, holding the runtime engine, the api contract tree, the typed bus, the canonical model, and the bundle.
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

//! Participant-facing asset reads.

use std::io::Read;

use crate::model::AssetId;

use crate::bundle::{ASSETS_DIR, BundleError, BundlePath, BundleRoot, open_bundle_file};

/// Reads the files below `<bundle>/assets`.
///
/// There is no declared asset set to consult: an [`AssetId`] is already a
/// validated relative forward-slash path with no `.` or `..` segment, and
/// The bundle path type validates the joined path again, so a read cannot name
/// anything outside `assets/`. That pair of checks is the whole fence.
#[derive(Clone, Debug)]
pub struct ParticipantAssets {
    root: BundleRoot,
}

impl ParticipantAssets {
    pub(crate) const fn new(root: BundleRoot) -> Self {
        Self { root }
    }

    pub(crate) fn relocate(&mut self, path: std::path::PathBuf) {
        self.root.relocate(path);
    }

    /// Read one asset out of the bundle.
    ///
    /// # Errors
    ///
    /// Returns a bundle error when the bundle carries no such asset, or when
    /// it carries one that cannot be read.
    pub fn read(&self, id: &AssetId) -> Result<Vec<u8>, BundleError> {
        let path = Self::path(id)?;
        let mut file = open_bundle_file(&self.root, &path)?;
        let mut bytes = Vec::new();
        file.read_to_end(&mut bytes)
            .map_err(|source| BundleError::ReadFile {
                path: path.filesystem_path(self.root.path()),
                source,
            })?;
        Ok(bytes)
    }

    /// Where one logical asset sits in the bundle.
    pub(crate) fn path(id: &AssetId) -> Result<BundlePath, BundleError> {
        Ok(BundlePath::new(format!("{ASSETS_DIR}/{}", id.as_str()))?)
    }
}