ic-asset-certification 3.2.0

Certification for static assets served over HTTP on the Internet Computer
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

use std::borrow::Cow;

/// An asset to be certified and served by an [AssetRouter](crate::AssetRouter).
///
/// Use the [new](Asset::new) associated function to create instances of
/// this struct.
///
/// # Examples
///
/// ## With owned values
///
/// ```
/// use ic_asset_certification::Asset;
///
/// let path = String::from("foo");
/// let content = vec![1, 2, 3];
///
/// let asset = Asset::new(path, content);
/// ```
///
/// ## With borrowed values
///
/// ```
/// use ic_asset_certification::Asset;
///
/// let path = "foo";
/// let content = [1, 2, 3].as_slice();
///
/// let asset = Asset::new(path, content);
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Asset<'content, 'path> {
    pub(crate) path: Cow<'path, str>,
    pub(crate) url: Cow<'path, str>,
    pub(crate) content: Cow<'content, [u8]>,
}

impl<'content, 'path> Asset<'content, 'path> {
    /// Creates a new asset with the given path and content.
    /// Both parameters may be owned values, or references so developers are free to
    /// choose whichever option is best suited for their use case.
    pub fn new(path: impl Into<Cow<'path, str>>, content: impl Into<Cow<'content, [u8]>>) -> Self {
        let path = path.into();

        Asset {
            url: Cow::Owned(path_to_url(path.as_ref())),
            path,
            content: content.into(),
        }
    }
}

fn path_to_url(path: &str) -> String {
    if !path.starts_with('/') {
        format!("/{path}")
    } else {
        path.to_string()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use rstest::*;

    #[rstest]
    fn asset_new_owned_values() {
        let path = String::from("foo");
        let content = vec![1, 2, 3];

        let asset = Asset::new(path.clone(), content.clone());

        assert_eq!(asset.path, path);
        assert_eq!(asset.url, "/foo");
        assert_eq!(asset.content, content);
    }

    #[rstest]
    fn asset_new_borrowed_values() {
        let path = "foo";
        let content = [1, 2, 3].as_slice();

        let asset = Asset::new(path, content);

        assert_eq!(asset.path, path);
        assert_eq!(asset.url, "/foo");
        assert_eq!(asset.content, content);
    }
}