Struct bee_message::milestone::MilestoneIndex

#[repr(transparent)]
pub struct MilestoneIndex(pub u32);

A wrapper around a u32 that represents a milestone index.

Implementations

impl MilestoneIndex

pub fn new(value: u32) -> Self

Creates a new MilestoneIndex.

Methods from Deref<Target = u32>

pub const MIN: u32

pub const MAX: u32

pub const BITS: u32

pub fn as_ne_bytes(&self) -> &[u8; 4]

🔬 This is a nightly-only experimental API. (num_as_ne_bytes)

Return the memory representation of this integer as a byte array in native byte order.

to_ne_bytes should be preferred over this whenever possible.

Examples

#![feature(num_as_ne_bytes)]
let num = 0x12345678u32;
let bytes = num.as_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        &[0x12, 0x34, 0x56, 0x78]
    } else {
        &[0x78, 0x56, 0x34, 0x12]
    }
);

Trait Implementations

impl Add<MilestoneIndex> for MilestoneIndex

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<u32> for MilestoneIndex

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: u32) -> Self

Performs the + operation.

impl Clone for MilestoneIndex

fn clone(&self) -> MilestoneIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MilestoneIndex

impl Debug for MilestoneIndex

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

Formats the value using the given formatter.

impl Default for MilestoneIndex

fn default() -> MilestoneIndex

Returns the “default value” for a type.

impl Deref for MilestoneIndex

type Target = u32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for MilestoneIndex

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

Formats the value using the given formatter.

impl Eq for MilestoneIndex

impl From<u32> for MilestoneIndex

fn from(v: u32) -> Self

Performs the conversion.

impl Hash for MilestoneIndex

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for MilestoneIndex

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl Packable for MilestoneIndex

type Error = Error

Associated error type.

fn packed_len(&self) -> usize

Returns the length of the packed bytes.

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

Packs the instance to bytes and writes them to the passed writer.

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error>

Reads bytes from the passed reader and unpacks them into an instance.

pub fn pack_new(&self) -> Vec<u8, Global>

Packs the instance to bytes and writes them to a newly allocated vector.

pub fn unpack<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read + ?Sized, 

Reads bytes from the passed reader and unpacks them into an instance. Applies syntactic checks.

pub fn unpack_unchecked<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read + ?Sized, 

Reads bytes from the passed reader and unpacks them into an instance. Doesn’t apply syntactic checks.

impl PartialEq<MilestoneIndex> for MilestoneIndex

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<MilestoneIndex> for MilestoneIndex

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl StructuralEq for MilestoneIndex

impl StructuralPartialEq for MilestoneIndex

impl Sub<MilestoneIndex> for MilestoneIndex

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<u32> for MilestoneIndex

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: u32) -> Self

Performs the - operation.