Struct SegmentIndex 

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

Segment index

Implementations

impl SegmentIndex

pub const ZERO: Self

Segment index 0

pub const ONE: Self

Segment index 1

pub const fn first_piece_index(&self) -> PieceIndex

Get the first piece index in this segment

pub const fn last_piece_index(&self) -> PieceIndex

Get the last piece index in this segment

pub fn segment_piece_indexes(&self) -> [PieceIndex; 256]

List of piece indexes that belong to this segment

pub fn checked_sub(self, rhs: Self) -> Option<Self>

Checked integer subtraction. Computes self - rhs, returning None if underflow occurred

pub const fn saturating_sub(self, rhs: Self) -> Self

Saturating integer subtraction. Computes self - rhs, returning zero if underflow occurred

Trait Implementations

impl Add for SegmentIndex

type Output = SegmentIndex

The resulting type after applying the + operator.

fn add(self, __rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for SegmentIndex

fn add_assign(&mut self, __rhs: Self)

Performs the += operation.

impl AnyBitPatternMarker for SegmentIndex

where for<'__ab_io_type> u64: AnyBitPatternMarker,

impl Clone for SegmentIndex

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SegmentIndex

impl Debug for SegmentIndex

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

Formats the value using the given formatter.

impl Decode for SegmentIndex

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

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

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 SegmentIndex

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SegmentIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SegmentIndex

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

Formats the value using the given formatter.

impl<__derive_more_Rhs> Div<__derive_more_Rhs> for SegmentIndex

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

type Output = SegmentIndex

The resulting type after applying the / operator.

fn div(self, __rhs: __derive_more_Rhs) -> Self::Output

Performs the / operation.

impl<__derive_more_Rhs> DivAssign<__derive_more_Rhs> for SegmentIndex

where u64: DivAssign<__derive_more_Rhs>,

fn div_assign(&mut self, __rhs: __derive_more_Rhs)

Performs the /= operation.

impl Encode for SegmentIndex

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 EncodeLike for SegmentIndex

impl Eq for SegmentIndex

impl From<HistorySize> for SegmentIndex

fn from(value: HistorySize) -> Self

Converts to this type from the input type.

impl From<SegmentIndex> for u64

fn from(value: SegmentIndex) -> Self

Converts to this type from the input type.

impl From<SegmentIndex> for HistorySize

fn from(value: SegmentIndex) -> Self

Converts to this type from the input type.

impl From<u64> for SegmentIndex

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Hash for SegmentIndex

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 SegmentIndex

fn max_encoded_len() -> usize

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

impl<__derive_more_Rhs> Mul<__derive_more_Rhs> for SegmentIndex

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

type Output = SegmentIndex

The resulting type after applying the * operator.

fn mul(self, __rhs: __derive_more_Rhs) -> Self::Output

Performs the * operation.

impl<__derive_more_Rhs> MulAssign<__derive_more_Rhs> for SegmentIndex

where u64: MulAssign<__derive_more_Rhs>,

fn mul_assign(&mut self, __rhs: __derive_more_Rhs)

Performs the *= operation.

impl Ord for SegmentIndex

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for SegmentIndex

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SegmentIndex

fn partial_cmp(&self, other: &Self) -> 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 SegmentIndex

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 SegmentIndex

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 forward_overflowing(start: Self, count: usize) -> (Self, bool)

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

Returns the value that would be obtained by taking the successor of self count times along with a boolean tracking whether overflow occurred.

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 backward_overflowing(start: Self, count: usize) -> (Self, bool)

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

Returns the value that would be obtained by taking the successor of self count times along with a boolean tracking whether overflow occurred.

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 StructuralPartialEq for SegmentIndex

impl Sub for SegmentIndex

type Output = SegmentIndex

The resulting type after applying the - operator.

fn sub(self, __rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for SegmentIndex

fn sub_assign(&mut self, __rhs: Self)

Performs the -= operation.

impl TrivialType for SegmentIndex

where u64: TrivialType,

const ALIGNMENT: Alignment

Alignment of the type in metadata.

const METADATA: &[u8]

Data structure metadata in binary form, describing shape and types of the contents, see IoTypeMetadataKind for encoding details.

const SIZE: u32

final fn try_from_bytes(bytes: &[u8]) -> Option<(&Self, &[u8])>

Parse the beginning of aligned bytes, returns the value and the remaining bytes.

final fn try_from_bytes_exact(bytes: &[u8]) -> Option<&Self>

Like Self::try_from_bytes(), but returns None if there are more bytes than the value

final fn try_from_bytes_mut(bytes: &mut [u8]) -> Option<(&mut Self, &mut [u8])>

Like Self::try_from_bytes(), but returns an exclusive reference.

final fn try_from_bytes_mut_exact(bytes: &mut [u8]) -> Option<&mut Self>

Like Self::try_from_bytes_mut(), but returns None if there are more bytes than the value

final fn from_bytes(bytes: &[u8]) -> Option<(&Self, &[u8])>

where Self: AnyBitPattern,

Create a reference to a value at the beginning of aligned bytes, returns the value and the remaining bytes.

final fn from_bytes_exact(bytes: &[u8]) -> Option<&Self>

where Self: AnyBitPattern,

Like Self::from_bytes(), but returns None if there are more bytes than the value

final unsafe fn from_bytes_unchecked(bytes: &[u8]) -> &Self

Similar to Self::from_bytes(), but for any type and without any checks

final fn from_bytes_mut(bytes: &mut [u8]) -> Option<(&mut Self, &mut [u8])>

where Self: AnyBitPattern,

Like Self::from_bytes(), but returns an exclusive reference

final fn from_bytes_mut_exact(bytes: &mut [u8]) -> Option<&mut Self>

where Self: AnyBitPattern,

Like Self::from_bytes_mut(), but returns None if there are more bytes than the value

final unsafe fn from_bytes_mut_unchecked(bytes: &mut [u8]) -> &mut Self

Similar to Self::from_bytes_mut(), but for any type and without any checks

final fn slice_from_bytes( bytes: &[u8], count: usize, ) -> Option<(&[Self], &[u8])>

where Self: AnyBitPattern,

Create a slice of count values at the beginning of aligned bytes, returns the values and the remaining bytes.

final fn slice_from_bytes_mut( bytes: &mut [u8], count: usize, ) -> Option<(&mut [Self], &mut [u8])>

where Self: AnyBitPattern,

Like Self::slice_from_bytes(), but returns an exclusive reference

final fn as_bytes(&self) -> &[u8; ab_io_type::trivial_type::SIZE_OF::<Self>]

Access the underlying byte representation of a data structure

final fn slice_as_bytes(values: &[Self]) -> &[u8]

Access the underlying byte representation of a slice of values

final fn as_bytes_mut( &mut self, ) -> &mut [u8; ab_io_type::trivial_type::SIZE_OF::<Self>]

where Self: AnyBitPattern,

Access the underlying mutable byte representation of a data structure

final unsafe fn as_bytes_mut_unchecked( &mut self, ) -> &mut [u8; ab_io_type::trivial_type::SIZE_OF::<Self>]

Similar to Self::as_bytes_mut(), but for any type.