Struct PeerBandwidth

pub struct PeerBandwidth(/* private fields */);

The message to tell the client-side bandwidth. This has 2 ways of comparision by which field you specifies.

Examples

use sheave_core::messages::{
    LimitType,
    PeerBandwidth,
};

let peer_bandwidth = PeerBandwidth::default();

// When you compare this message with a bandwidth number.
assert!(2500000u32 == peer_bandwidth);
assert!(0 <= peer_bandwidth);
// When you compare this message with a limit type.
assert!(LimitType::default() == peer_bandwidth)

Implementations

impl PeerBandwidth

pub fn new(peer_bandwidth: u32, limit_type: LimitType) -> Self

Constructs a PeerBandwidth message.

pub fn get_inner_bandwidth(&self) -> u32

pub fn get_inner_limit_type(&self) -> LimitType

Trait Implementations

impl ChunkData for PeerBandwidth

const CHANNEL: Channel = Channel::Network

const MESSAGE_TYPE: MessageType = MessageType::PeerBandwidth

impl Clone for PeerBandwidth

fn clone(&self) -> PeerBandwidth

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PeerBandwidth

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decoder<PeerBandwidth> for ByteBuffer

fn decode(&mut self) -> IOResult<PeerBandwidth>

Decodes bytes into a PeerBandwidth message.

Errors

• InsufficientBufferLength

When this buffer didn’t remain at least 5 bytes.

Examples

use sheave_core::{
    ByteBuffer,
    Decoder,
    messages::PeerBandwidth
};

let mut buffer = ByteBuffer::default();
buffer.put_u32_be(u32::default());
buffer.put_u8(u8::default());
assert!(Decoder::<PeerBandwidth>::decode(&mut buffer).is_ok())

impl Default for PeerBandwidth

fn default() -> Self

Constructs a PeerBandwidth message with the default bandwidth and the default limit type (2500000 in bits, 2 (Dynamic)).

Examples

use sheave_core::messages::{
    LimitType,
    PeerBandwidth
};

let peer_bandwidth = PeerBandwidth::default();
assert_eq!(2500000u32, peer_bandwidth);
assert_eq!(LimitType::default(), peer_bandwidth)

impl Div<u32> for PeerBandwidth

type Output = PeerBandwidth

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl Encoder<PeerBandwidth> for ByteBuffer

fn encode(&mut self, peer_bandwidth: &PeerBandwidth)

Encodes a PeerBandwidth message into bytes.

impl Ord for PeerBandwidth

fn cmp(&self, other: &PeerBandwidth) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<Acknowledgement> for PeerBandwidth

fn eq(&self, other: &Acknowledgement) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<LimitType> for PeerBandwidth

fn eq(&self, other: &LimitType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<PeerBandwidth> for Acknowledgement

fn eq(&self, other: &PeerBandwidth) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<PeerBandwidth> for LimitType

fn eq(&self, other: &PeerBandwidth) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<PeerBandwidth> for u32

fn eq(&self, other: &PeerBandwidth) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u32> for PeerBandwidth

fn eq(&self, other: &u32) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for PeerBandwidth

fn eq(&self, other: &PeerBandwidth) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Acknowledgement> for PeerBandwidth

fn partial_cmp(&self, other: &Acknowledgement) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<PeerBandwidth> for Acknowledgement

fn partial_cmp(&self, other: &PeerBandwidth) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<PeerBandwidth> for u32

fn partial_cmp(&self, other: &PeerBandwidth) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<u32> for PeerBandwidth

fn partial_cmp(&self, other: &u32) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for PeerBandwidth

fn partial_cmp(&self, other: &PeerBandwidth) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for PeerBandwidth

impl Eq for PeerBandwidth

impl StructuralPartialEq for PeerBandwidth