Struct BlockSize 

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

Block size in bytes, checked against the valid range.

Sizes run 65 KiB through 511 MiB. The default is 16 MiB. Level 1 selects MIN, level 14 selects MAX; levels 2-13 are powers of two from 128 KiB to 256 MiB.

Examples

use bzip3_rs::BlockSize;

let size = BlockSize::kib(128)?;
assert_eq!(size.get(), 131_072);
assert!(BlockSize::MIN < size && size < BlockSize::MAX);
assert_eq!(BlockSize::default(), BlockSize::DEFAULT);

Implementations

impl BlockSize

pub const MIN: Self

Smallest valid size: 65 KiB.

pub const MAX: Self

Largest valid size: 511 MiB.

pub const DEFAULT: Self

Default size: 16 MiB.

pub const fn new(size: u32) -> Result<Self>

Build from a byte count.

Errors

Returns Error::InvalidBlockSize when size is outside MIN..=MAX.

Examples

use bzip3_rs::BlockSize;

assert!(BlockSize::new(1024 * 1024).is_ok());
assert!(BlockSize::new(1024).is_err()); // Below `MIN`.
assert!(BlockSize::new(u32::MAX).is_err()); // Above `MAX`.

pub const fn kib(kibibytes: u32) -> Result<Self>

Build from a kibibyte count.

Errors

Returns Error::InvalidBlockSize when the size is outside MIN..=MAX or the multiplication overflows.

Examples

use bzip3_rs::BlockSize;

assert_eq!(BlockSize::kib(65)?, BlockSize::MIN);
assert!(BlockSize::kib(64).is_err());

pub const fn mib(mebibytes: u32) -> Result<Self>

Build from a mebibyte count.

Errors

Returns Error::InvalidBlockSize when the size is outside MIN..=MAX or the multiplication overflows.

Examples

use bzip3_rs::BlockSize;

assert_eq!(BlockSize::mib(16)?, BlockSize::DEFAULT);
assert!(BlockSize::mib(512).is_err());

pub const fn from_level(level: u8) -> Result<Self>

Build from a compression level 1-14.

Level 1 selects Self::MIN (65 KiB). Levels 2-13 are powers of two: 128 KiB, 256 KiB, 512 KiB, 1 MiB, 2 MiB, 4 MiB, 8 MiB, 16 MiB, 32 MiB, 64 MiB, 128 MiB, 256 MiB. Level 14 selects Self::MAX (511 MiB). Level 9 matches Self::DEFAULT.

Errors

Returns Error::InvalidBlockSize when level is outside 1-14.

Examples

use bzip3_rs::BlockSize;

assert_eq!(BlockSize::from_level(1)?, BlockSize::MIN);
assert_eq!(BlockSize::from_level(9)?, BlockSize::DEFAULT);
assert_eq!(BlockSize::from_level(14)?, BlockSize::MAX);
assert!(BlockSize::from_level(0).is_err());

pub const fn get(self) -> u32

Return the size in bytes.

Examples

use bzip3_rs::BlockSize;

assert_eq!(BlockSize::MIN.get(), 65 * 1024);

pub const fn as_usize(self) -> usize

Return the size in bytes as usize.

On 16-bit targets the value truncates like as.

Examples

use bzip3_rs::BlockSize;

let buffer = vec![0_u8; BlockSize::MIN.as_usize()];
assert_eq!(buffer.len(), 65 * 1024);

Trait Implementations

impl Clone for BlockSize

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 BlockSize

impl Debug for BlockSize

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

Formats the value using the given formatter.

impl Default for BlockSize

fn default() -> Self

Returns the “default value” for a type.

impl Eq for BlockSize

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: &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 BlockSize

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BlockSize

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