mr_bundle 0.6.3

Implements the un-/packing of bundles that either embed or reference a set of resources
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

//! Custom error types for the mr_bundle crate

use crate::manifest::ResourceIdentifier;

/// Any error which can occur in this crate
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum MrBundleError {
    /// An IO error
    #[error("{0}: {1}")]
    IoError(String, std::io::Error),

    /// A manifest references resources that were not provided when attempting to create a bundle.
    #[error("Manifest references resources that were not provided when attempting to create a bundle: {0:?}")]
    MissingResources(Vec<ResourceIdentifier>),

    /// Resources were provided when attempting to create a bundle that were not referenced in the manifest.
    #[error("Resources were provided when attempting to create a bundle that were not referenced in the manifest: {0:?}")]
    UnusedResources(Vec<ResourceIdentifier>),

    /// A messagepack encoding error
    #[error(transparent)]
    MsgpackEncodeError(#[from] rmp_serde::encode::Error),

    /// A messagepack decoding error
    #[error("Failed to decode bundle to [{0}] due to a deserialization error: {1}")]
    MsgpackDecodeError(String, rmp_serde::decode::Error),

    /// A YAML error
    #[cfg(feature = "fs")]
    #[cfg_attr(docsrs, doc(cfg(feature = "fs")))]
    #[error(transparent)]
    YamlError(#[from] serde_yaml::Error),

    /// A path with no parent directory
    #[cfg(feature = "fs")]
    #[cfg_attr(docsrs, doc(cfg(feature = "fs")))]
    #[error("The supplied path '{0}' has no parent directory.")]
    ParentlessPath(std::path::PathBuf),

    /// A target directory already exists
    #[cfg(feature = "fs")]
    #[cfg_attr(docsrs, doc(cfg(feature = "fs")))]
    #[error("The target directory '{0}' already exists.")]
    DirectoryExists(std::path::PathBuf),
}

/// A custom result that uses [`MrBundleError`] as the error type.
pub type MrBundleResult<T> = Result<T, MrBundleError>;