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

// Copyright 2018 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// 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 crate::error::{Error, Result};
use serde::{Deserialize, Serialize};
use xor_name::{Prefix, XorName};

/// Message source location.
#[derive(Clone, Copy, Eq, PartialEq, Hash, Serialize, Deserialize, Debug)]
pub enum SrcLocation {
    /// A single node with the given name.
    Node(XorName),
    /// A section with the given prefix.
    Section(Prefix),
}

impl SrcLocation {
    /// Returns whether this location is a section.
    pub fn is_section(&self) -> bool {
        match self {
            Self::Section(_) => true,
            Self::Node(_) => false,
        }
    }

    /// Returns whether the given name is part of this location
    pub(crate) fn contains(&self, name: &XorName) -> bool {
        match self {
            SrcLocation::Node(self_name) => name == self_name,
            SrcLocation::Section(self_prefix) => self_prefix.matches(name),
        }
    }

    /// Returns this location as `DstLocation`
    pub fn to_dst(&self) -> DstLocation {
        match self {
            Self::Node(name) => DstLocation::Node(*name),
            Self::Section(prefix) => DstLocation::Section(prefix.name()),
        }
    }
}

/// Message destination location.
#[derive(Clone, Copy, Eq, PartialEq, Hash, Serialize, Deserialize, Debug)]
pub enum DstLocation {
    /// Destination is a single node with the given name.
    Node(XorName),
    /// Destination are the nodes of the section whose prefix matches the given name.
    Section(XorName),
    /// Destination is the node at the `ConnectionInfo` the message is directly sent to.
    Direct,
}

impl DstLocation {
    /// Returns whether this location is a section.
    pub fn is_section(&self) -> bool {
        match self {
            Self::Section(_) => true,
            Self::Node(_) | Self::Direct => false,
        }
    }

    /// If this location is `Node`, returns its name, otherwise `Err(BadLocation)`.
    pub(crate) fn as_node(&self) -> Result<&XorName> {
        match self {
            Self::Node(name) => Ok(name),
            Self::Section(_) | Self::Direct => Err(Error::InvalidDstLocation),
        }
    }

    /// Returns `Ok` if this location is section, `Err(BadLocation)` otherwise.
    pub(crate) fn check_is_section(&self) -> Result<()> {
        match self {
            Self::Section(_) => Ok(()),
            Self::Node(_) | Self::Direct => Err(Error::InvalidDstLocation),
        }
    }

    /// Returns whether the given name of the given prefix is part of this location.
    ///
    /// # Panics
    ///
    /// Panics if `prefix` does not match `name`.
    pub(crate) fn contains(&self, name: &XorName, prefix: &Prefix) -> bool {
        assert!(prefix.matches(name));

        match self {
            Self::Node(self_name) => name == self_name,
            Self::Section(self_name) => prefix.matches(self_name),
            Self::Direct => true,
        }
    }

    /// Returns the name of this location, or `None` if it is `Direct`.
    pub(crate) fn name(&self) -> Option<&XorName> {
        match self {
            Self::Node(name) => Some(name),
            Self::Section(name) => Some(name),
            Self::Direct => None,
        }
    }
}