safe_network_common 0.7.0

Common code for safe_vault and safe_core
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

// Copyright 2016 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under (1) the MaidSafe.net Commercial License,
// version 1.0 or later, or (2) The General Public License (GPL), version 3, depending on which
// licence you accepted on initial access to the Software (the "Licences").
//
// By contributing code to the SAFE Network Software, or to this project generally, you agree to be
// bound by the terms of the MaidSafe Contributor Agreement, version 1.0.  This, along with the
// Licenses can be found in the root directory of this project at LICENSE, COPYING and CONTRIBUTOR.
//
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.
//
// Please review the Licences for the specific language governing permissions and limitations
// relating to use of the SAFE Network Software.

use std::error::Error as StdError;
use std::fmt::{self, Display, Formatter};

use maidsafe_utilities::serialisation::SerialisationError;

/// Error types relating to MPID messaging.
#[derive(Debug)]
pub enum Error {
    /// Used where the length of a [header's `metadata`](struct.MpidHeader.html#method.new) exceeds
    /// [`MAX_HEADER_METADATA_SIZE`](constant.MAX_HEADER_METADATA_SIZE.html).
    MetadataTooLarge,
    /// Used where the length of a [message's `body`](struct.MpidMessage.html#method.new) exceeds
    /// [`MAX_BODY_SIZE`](constant.MAX_BODY_SIZE.html).
    BodyTooLarge,
    /// Serialisation error.
    Serialisation(SerialisationError),
}

impl Display for Error {
    fn fmt(&self, formatter: &mut Formatter) -> fmt::Result {
        match *self {
            Error::MetadataTooLarge => write!(formatter, "Message header too large"),
            Error::BodyTooLarge => write!(formatter, "Message body too large"),
            Error::Serialisation(ref error) => write!(formatter, "Serialisation error: {}", error),
        }
    }
}

impl StdError for Error {
    fn description(&self) -> &str {
        match *self {
            Error::MetadataTooLarge => "Header too large",
            Error::BodyTooLarge => "Body too large",
            Error::Serialisation(ref error) => error.description(),
        }
    }

    fn cause(&self) -> Option<&StdError> {
        match *self {
            Error::Serialisation(ref error) => Some(error),
            _ => None,
        }
    }
}

impl From<SerialisationError> for Error {
    fn from(error: SerialisationError) -> Error {
        Error::Serialisation(error)
    }
}