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
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

//! WNFS Errors

use semver::Version;
use skip_ratchet::PreviousErr;
use thiserror::Error;
use wnfs_common::NodeType;

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

/// Core file system errors.
#[derive(Debug, Error)]
pub enum FsError {
    #[error("Invalid WNFS path")]
    InvalidPath,

    #[error("Expected a file")]
    NotAFile,

    #[error("Expected a directory")]
    NotADirectory,

    #[error("Cannot find file or directory")]
    NotFound,

    #[error("File already exists")]
    FileAlreadyExists,

    #[error("Directory already exists")]
    DirectoryAlreadyExists,

    #[error("Invalid deserialization: {0}")]
    InvalidDeserialization(String),

    #[error("Missing node type field")]
    MissingNodeType,

    #[error("Found unexpected node type, expected {0:?}")]
    UnexpectedNodeType(NodeType),

    #[error("Found unexpected version: {0:?}")]
    UnexpectedVersion(Version),

    #[error("Cannot compute in-between ratchet {0}")]
    NoIntermediateRatchet(PreviousErr),

    #[error("Cannot find shard for file content")]
    FileShardNotFound,

    #[error("Cannot merge or compare forests, incompatible accumulator setups")]
    IncompatibleAccumulatorSetups,

    #[error("Mismatch between PrivateNode name {0} and its mountpoint {0}")]
    MountPointAndDeserializedNameMismatch(String, String),

    #[error("Cannot find the partition with this name")]
    PartitionNotFound,
}

/// Data sharing related errors
#[derive(Debug, Error)]
pub enum ShareError {
    #[error("No sharer or recipients")]
    NoSharerOrRecipients,

    #[error("Access key not found")]
    AccessKeyNotFound,
}

/// Symmetric encryption errors.
#[derive(Debug, Error)]
pub enum CryptError {
    #[error("Unable to encrypt data: {0}")]
    UnableToEncrypt(anyhow::Error),

    #[error("Unable to decrypt data: {0}")]
    UnableToDecrypt(anyhow::Error),
}

/// RSA related errors
#[cfg(test)]
#[derive(Debug, Error)]
pub enum RsaError {
    #[error("Invalid public key: {0}")]
    InvalidPublicKey(anyhow::Error),

    #[error("Encryption failed: {0}")]
    EncryptionFailed(anyhow::Error),

    #[error("Decryption failed: {0}")]
    DecryptionFailed(anyhow::Error),
}

#[derive(Debug, Error)]
pub enum VerificationError {
    #[error("Couldn't verify write for label {0}")]
    UnverifiedWrite(String),

    #[error("Write to disallowed base {0}")]
    WriteToDisallowedBase(String),
}

/// AccessKey related errors.
#[derive(Debug, Error)]
pub enum AccessKeyError {
    #[error("Snapshot access keys cannot be used to derive private refs")]
    UnsupportedSnapshotPrivateRefDerive,
}