wnfs 0.3.0

WebNative filesystem core implementation
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

use super::SnapshotKey;
use crate::private::{FileContent, encrypted::Encrypted};
use semver::Version;
use serde::{Deserialize, Serialize};
use skip_ratchet::Ratchet;
use std::collections::BTreeMap;
use wnfs_common::{Cid, HashOutput, Metadata};
use wnfs_nameaccumulator::{NameAccumulator, NameSegment};

//--------------------------------------------------------------------------------------------------
// Type Definitions
//--------------------------------------------------------------------------------------------------

#[derive(Debug, Clone, Serialize, Deserialize)]
#[allow(clippy::large_enum_variant)]
pub(crate) enum PrivateNodeContentSerializable {
    #[serde(rename = "wnfs/priv/file")]
    File(PrivateFileContentSerializable),
    #[serde(rename = "wnfs/priv/dir")]
    Dir(PrivateDirectoryContentSerializable),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct PrivateFileContentSerializable {
    pub version: Version,
    pub header_cid: Cid,
    pub previous: Vec<(usize, Encrypted<Cid>)>,
    pub metadata: Metadata,
    pub content: FileContent,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct PrivateDirectoryContentSerializable {
    pub version: Version,
    pub previous: Vec<(usize, Encrypted<Cid>)>,
    pub header_cid: Cid,
    pub metadata: Metadata,
    pub entries: BTreeMap<String, PrivateRefSerializable>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct PrivateNodeHeaderSerializable {
    /// A unique identifier of the node.
    pub inumber: NameSegment,
    /// Used both for versioning and deriving keys for that enforces privacy.
    pub ratchet: Ratchet,
    /// Stores the name of this node for easier lookup.
    pub name: NameAccumulator,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct PrivateRefSerializable {
    #[serde(with = "serde_byte_array")]
    pub label: HashOutput,
    pub snapshot_key: SnapshotKey,
    #[serde(with = "serde_bytes")]
    pub temporal_key: Vec<u8>,
    pub content_cid: Cid,
}