bee-protocol-types 1.0.1

All types enabling the IOTA protocol.
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

// Copyright 2020-2022 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

//! A module that provides a milestone key range type.

use core::cmp::Ordering;

use bee_block::payload::milestone::MilestoneIndex;
use serde::{Deserialize, Serialize};

/// A milestone key range is a milestone public key valid for a given interval of milestones.
#[derive(Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct MilestoneKeyRange {
    #[serde(alias = "publicKey")]
    public_key: String,
    // Inclusive bound.
    start: MilestoneIndex,
    // Inclusive bound.
    end: MilestoneIndex,
}

impl MilestoneKeyRange {
    /// Creates a new `MilestoneKeyRange`.
    pub fn new(public_key: String, start: MilestoneIndex, end: MilestoneIndex) -> Self {
        Self { public_key, start, end }
    }

    /// Returns the public key of the `MilestoneKeyRange`.
    pub fn public_key(&self) -> &String {
        &self.public_key
    }

    /// Returns the start index of the `MilestoneKeyRange`.
    pub fn start(&self) -> MilestoneIndex {
        self.start
    }

    /// Return the end index of the `MilestoneKeyRange`.
    pub fn end(&self) -> MilestoneIndex {
        self.end
    }
}

impl Ord for MilestoneKeyRange {
    fn cmp(&self, other: &Self) -> Ordering {
        self.start.cmp(&other.start)
    }
}

impl PartialOrd for MilestoneKeyRange {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}