Struct BlockInfo

pub struct BlockInfo(pub u32);

Type for interpreting block1 and block2 option values.

Tuple Fields

0: u32

Implementations

impl BlockInfo

pub const NUM_MAX: u32 = 1_048_575u32

Maximum legal value for num.

pub const SZX_MAX: u8 = 6u8

Maximum legal value for szx.

pub fn new(num: u32, m: bool, szx: u8) -> Option<BlockInfo>

Constructs a new BlockInfo from the number, more flag, and size exponent.

pub fn num(&self) -> u32

Block number value.

pub fn more_flag(&self) -> bool

More flag value. If set, there are more blocks to follow.

pub fn szx(&self) -> u8

Block size exponent field value.

pub fn offset(&self) -> usize

The offset (in bytes) that this block starts at.

pub fn len(&self) -> usize

The length of this block, in bytes.

pub fn is_max_block(&self) -> bool

Determines if calling BlockInfo::next will yield the next block or not.

If this method returns true, calling BlockInfo::next will fail.

pub fn is_invalid(&self) -> bool

Checks the validity of the contained value.

pub fn valid(self) -> Option<BlockInfo>

Checks the contained value for validity and, if valid, returns it in an Option.

pub fn next(&self) -> Option<BlockInfo>

Calculates what the next block will be, if any.

pub fn smaller(&self) -> Option<BlockInfo>

Calculates a smaller block size that maintains this block’s offset.

pub fn with_more_flag(&self) -> BlockInfo

Returns this BlockInfo’s value with the more flag set.

pub fn without_more_flag(&self) -> BlockInfo

Returns this BlockInfo’s value without the more flag set.

Trait Implementations

impl Clone for BlockInfo

fn clone(&self) -> BlockInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockInfo

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

Formats the value using the given formatter.

impl Default for BlockInfo

fn default() -> Self

Returns a block info with an offset of zero and a block size of 1024.

impl Display for BlockInfo

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

Formats the value using the given formatter.

impl From<u32> for BlockInfo

fn from(x: u32) -> Self

Converts to this type from the input type.

impl Hash for BlockInfo

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 Ord for BlockInfo

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

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

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

impl Eq for BlockInfo

impl StructuralPartialEq for BlockInfo