Enum BufferSize 

#[repr(usize)]
pub enum BufferSize {
    S8 = 8,
    S16 = 16,
    S32 = 32,
    S64 = 64,
    S128 = 128,
    S256 = 256,
    S512 = 512,
    S1024 = 1_024,
    S2048 = 2_048,
    S4096 = 4_096,
    S8192 = 8_192,
    S16384 = 16_384,
}

Size of a single IO buffer.

All variants are powers of two, which enables efficient alignment, masking, indexing, and allocator-friendly memory layouts throughout the storage engine.

The value of each variant is the buffer size in bytes.

NOTE: The BufferSize::S16384 is an upper limit for available buffer sizes, as it is large enough to never create any sort of inconvience for the user, and small enough to never create overflow issues in arithmatic operation across storage engine/s.

Example

let buf_size = frozen_core::utils::BufferSize::S128.bytes();
assert!(frozen_core::utils::is_power_of_2(buf_size));

Variants

S8 = 8

8 bytes

S16 = 16

16 bytes

S32 = 32

32 bytes

S64 = 64

64 bytes

S128 = 128

128 bytes

S256 = 256

256 bytes

S512 = 512

512 bytes

S1024 = 1_024

1 KiB (1024 bytes)

S2048 = 2_048

2 KiB (2048 bytes)

S4096 = 4_096

4 KiB (4096 bytes)

S8192 = 8_192

8 KiB (8192 bytes)

S16384 = 16_384

16 KiB (16384 bytes)

Implementations

impl BufferSize

pub const fn bytes(self) -> usize

Returns the buffer size in bytes

Trait Implementations

impl Clone for BufferSize

fn clone(&self) -> BufferSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BufferSize

impl Debug for BufferSize

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

Formats the value using the given formatter.

impl Eq for BufferSize

impl Ord for BufferSize

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

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

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