Struct BlockSize

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

A block size.

Block sizes are powers of 2, with the smallest being 1024 bytes. They are encoded as the power of 2, minus 10, so 1 is 1024 bytes, 2 is 2048 bytes, etc.

Since only powers of 2 are valid, the log2 of the size in bytes / 1024 is given in the constructor. So a block size of 0 is 1024 bytes, 1 is 2048 bytes, etc.

The actual size in bytes can be computed with BlockSize::bytes.

Implementations

impl BlockSize

pub const ZERO: BlockSize

The default block size, 1024 bytes

This means that blocks and blake3 chunks are the same size.

pub const fn from_chunk_log(chunk_log: u8) -> Self

Create a block size from the log2 of the size in bytes / 1024

0 is 1024 bytes, 1 is 2048 bytes, etc.

pub const fn chunk_log(self) -> u8

Get the log2 of the number of 1 KiB blocks in a chunk.

pub const fn bytes(self) -> usize

Number of bytes in a block at this level

pub const fn from_bytes(bytes: u64) -> Option<Self>

Compute a block size from bytes

Trait Implementations

impl Clone for BlockSize

fn clone(&self) -> BlockSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockSize

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

Formats the value using the given formatter.

impl Display for BlockSize

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

Formats the value using the given formatter.

impl Hash for BlockSize

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 BlockSize

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

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

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

impl Eq for BlockSize

impl StructuralPartialEq for BlockSize