Struct PieceIndex

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

Piece index in consensus

Implementations

impl PieceIndex

pub const SIZE: usize = 8usize

Size in bytes.

pub const ZERO: PieceIndex

Piece index 0.

pub const ONE: PieceIndex

Piece index 1.

pub const fn new(n: u64) -> Self

Create new instance

pub const fn from_bytes(bytes: [u8; 8]) -> Self

Create piece index from bytes.

pub const fn to_bytes(self) -> [u8; 8]

Convert piece index to bytes.

pub const fn segment_index(&self) -> SegmentIndex

Segment index piece index corresponds to

pub const fn position(&self) -> u32

Position of a piece in a segment

pub const fn source_position(&self) -> u32

Position of a source piece in the source pieces for a segment. Panics if the piece is not a source piece.

pub const fn from_source_position( source_position: u32, segment_index: SegmentIndex, ) -> PieceIndex

Returns the piece index for a source position and segment index. Overflows to the next segment if the position is greater than the last source position.

pub const fn is_source(&self) -> bool

Is this piece index a source piece?

pub const fn next_source_index(&self) -> PieceIndex

Returns the next source piece index. Panics if the piece is not a source piece.

pub const fn prev_source_index(&self) -> Option<PieceIndex>

Returns the previous source piece index, if there is one. Panics if the piece is not a source piece.

Trait Implementations

impl Add for PieceIndex

type Output = PieceIndex

The resulting type after applying the + operator.

fn add(self, rhs: PieceIndex) -> PieceIndex

Performs the + operation.

impl AddAssign for PieceIndex

fn add_assign(&mut self, rhs: PieceIndex)

Performs the += operation.

impl Clone for PieceIndex

fn clone(&self) -> PieceIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PieceIndex

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

Formats the value using the given formatter.

impl Decode for PieceIndex

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, dst_: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for PieceIndex

fn default() -> PieceIndex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PieceIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PieceIndex

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

Formats the value using the given formatter.

impl<__RhsT> Div<__RhsT> for PieceIndex

where u64: Div<__RhsT, Output = u64>,

type Output = PieceIndex

The resulting type after applying the / operator.

fn div(self, rhs: __RhsT) -> PieceIndex

Performs the / operation.

impl<__RhsT> DivAssign<__RhsT> for PieceIndex

where u64: DivAssign<__RhsT>,

fn div_assign(&mut self, rhs: __RhsT)

Performs the /= operation.

impl Encode for PieceIndex

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<__CodecOutputReturn, __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<PieceIndex> for u64

fn from(original: PieceIndex) -> Self

Converts to this type from the input type.

impl From<u64> for PieceIndex

fn from(original: u64) -> Self

Converts to this type from the input type.

impl Hash for PieceIndex

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl MaxEncodedLen for PieceIndex

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<__RhsT> Mul<__RhsT> for PieceIndex

where u64: Mul<__RhsT, Output = u64>,

type Output = PieceIndex

The resulting type after applying the * operator.

fn mul(self, rhs: __RhsT) -> PieceIndex

Performs the * operation.

impl<__RhsT> MulAssign<__RhsT> for PieceIndex

where u64: MulAssign<__RhsT>,

fn mul_assign(&mut self, rhs: __RhsT)

Performs the *= operation.

impl Ord for PieceIndex

fn cmp(&self, other: &PieceIndex) -> 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 for PieceIndex

fn eq(&self, other: &PieceIndex) -> 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 for PieceIndex

fn partial_cmp(&self, other: &PieceIndex) -> 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 Serialize for PieceIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Step for PieceIndex

fn steps_between(start: &Self, end: &Self) -> (usize, Option<usize>)

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

Returns the bounds on the number of successor steps required to get from start to end like Iterator::size_hint().

fn forward_checked(start: Self, count: usize) -> Option<Self>

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

Returns the value that would be obtained by taking the successor of self count times.

fn backward_checked(start: Self, count: usize) -> Option<Self>

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

Returns the value that would be obtained by taking the predecessor of self count times.

fn forward(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the successor of self count times.

unsafe fn forward_unchecked(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the successor of self count times.

fn backward(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the predecessor of self count times.

unsafe fn backward_unchecked(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the predecessor of self count times.

impl Sub for PieceIndex

type Output = PieceIndex

The resulting type after applying the - operator.

fn sub(self, rhs: PieceIndex) -> PieceIndex

Performs the - operation.

impl SubAssign for PieceIndex

fn sub_assign(&mut self, rhs: PieceIndex)

Performs the -= operation.

impl TypeInfo for PieceIndex

type Identity = PieceIndex

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for PieceIndex

impl EncodeLike for PieceIndex

impl Eq for PieceIndex

impl StructuralPartialEq for PieceIndex