safe-nd 0.10.4

Safe Network Data Types
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

// Copyright 2019 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under the MIT license <LICENSE-MIT
// https://opensource.org/licenses/MIT> or the Modified BSD license <LICENSE-BSD
// https://opensource.org/licenses/BSD-3-Clause>, at your option. This file may not be copied,
// modified, or distributed except according to those terms. Please review the Licences for the
// specific language governing permissions and limitations relating to use of the SAFE Network
// Software.

mod client_req;
mod coins;
mod idata;
mod login_packet;
mod mdata;
mod sdata;

pub use self::login_packet::{LoginPacket, LoginPacketRequest, MAX_LOGIN_PACKET_BYTES};
use crate::{Error, Response, XorName};
pub use client_req::ClientRequest;
pub use coins::CoinsRequest;
pub use idata::IDataRequest;
pub use mdata::MDataRequest;
pub use sdata::SDataRequest;
use serde::{Deserialize, Serialize};
use std::{borrow::Cow, fmt};

/// The type of a `Request`.
#[derive(Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, Debug)]
pub enum Type {
    /// Request is a Get for public data.
    PublicGet,
    /// Request is a Get for private data.
    PrivateGet,
    /// Request is a Mutation.
    Mutation,
    /// Request is a Transaction.
    Transaction,
}

/// The kind of authorisation needed for a request.
pub enum AuthorisationKind {
    /// Get request against public data.
    GetPub,
    /// Get request against private data.
    GetPriv,
    /// Request to get balance.
    GetBalance,
    /// Mutation request.
    Mutation,
    /// Request to manage app keys.
    ManageAppKeys,
    /// Request to transfer coins
    TransferCoins,
    /// Request to mutate and transfer coins
    MutAndTransferCoins,
}

/// RPC Request that is sent to vaults.
#[allow(clippy::large_enum_variant)]
#[derive(Hash, Eq, PartialEq, PartialOrd, Clone, Serialize, Deserialize)]
pub enum Request {
    /// ImmutableData request
    IData(IDataRequest),
    /// MutableData request
    MData(MDataRequest),
    /// Sequence request
    SData(SDataRequest),
    /// Coins request
    Coins(CoinsRequest),
    /// LoginPacket request
    LoginPacket(LoginPacketRequest),
    /// Client (Owner) request
    Client(ClientRequest),
}

impl Request {
    /// Get the `Type` of this `Request`.
    pub fn get_type(&self) -> Type {
        use Request::*;
        match self {
            IData(req) => req.get_type(),
            MData(req) => req.get_type(),
            SData(req) => req.get_type(),
            Coins(req) => req.get_type(),
            LoginPacket(req) => req.get_type(),
            Client(req) => req.get_type(),
        }
    }

    /// Creates a Response containing an error, with the Response variant corresponding to the
    /// Request variant.
    pub fn error_response(&self, error: Error) -> Response {
        use Request::*;
        match self {
            IData(req) => req.error_response(error),
            MData(req) => req.error_response(error),
            SData(req) => req.error_response(error),
            Coins(req) => req.error_response(error),
            LoginPacket(req) => req.error_response(error),
            Client(req) => req.error_response(error),
        }
    }

    /// Returns the type of authorisation needed for the request.
    pub fn authorisation_kind(&self) -> AuthorisationKind {
        use Request::*;
        match self {
            IData(req) => req.authorisation_kind(),
            MData(req) => req.authorisation_kind(),
            SData(req) => req.authorisation_kind(),
            Coins(req) => req.authorisation_kind(),
            LoginPacket(req) => req.authorisation_kind(),
            Client(req) => req.authorisation_kind(),
        }
    }

    /// Returns the address of the destination for `request`.
    pub fn dest_address(&self) -> Option<Cow<XorName>> {
        use Request::*;
        match self {
            IData(req) => req.dest_address(),
            MData(req) => req.dest_address(),
            SData(req) => req.dest_address(),
            Coins(req) => req.dest_address(),
            LoginPacket(req) => req.dest_address(),
            Client(req) => req.dest_address(),
        }
    }
}

impl fmt::Debug for Request {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        use Request::*;

        match self {
            IData(req) => write!(formatter, "{:?}", req),
            MData(req) => write!(formatter, "{:?}", req),
            SData(req) => write!(formatter, "{:?}", req),
            Coins(req) => write!(formatter, "{:?}", req),
            LoginPacket(req) => write!(formatter, "{:?}", req),
            Client(req) => write!(formatter, "{:?}", req),
        }
    }
}