ChunkSize

Struct ChunkSize 

Source
pub struct ChunkSize { /* private fields */ }
Expand description

Value object representing a chunk size with validation

This struct provides a type-safe representation of chunk sizes used throughout the adaptive pipeline system. It ensures chunk sizes are within valid bounds and provides convenient methods for working with chunk sizes.

§Key Features

  • Validation: Ensures chunk sizes are within acceptable bounds (1 byte to 512MB)
  • Type Safety: Prevents invalid chunk sizes at compile time
  • Immutability: Once created, chunk sizes cannot be modified
  • Serialization: Full JSON and binary serialization support
  • Performance: Optimized for frequent use in processing pipelines

§Constraints

  • Minimum Size: 1 byte (prevents degenerate cases)
  • Maximum Size: 512MB (prevents memory exhaustion)
  • Default Size: 1MB (balanced for most use cases)

§Examples

Implementations§

Source§

impl ChunkSize

Source

pub const MIN_SIZE: usize = 1usize

Minimum chunk size (1 byte) - must be at least 1 byte for processing

Source

pub const MAX_SIZE: usize = 536_870_912usize

Maximum chunk size (512MB) - prevents memory exhaustion

Source

pub const DEFAULT_SIZE: usize = 1_048_576usize

Default chunk size (1MB)

Source

pub fn new(bytes: usize) -> Result<Self, PipelineError>

Creates a new chunk size with validation

Validates that the specified size is within acceptable bounds before creating the chunk size instance.

§Arguments
  • bytes - Size in bytes (must be between 1 byte and 512MB)
§Returns
  • Ok(ChunkSize) - Valid chunk size
  • Err(PipelineError::InvalidConfiguration) - If size is out of bounds
§Errors

Returns an error if:

  • Size is less than MIN_SIZE (1 byte)
  • Size exceeds MAX_SIZE (512MB)
§Examples
Source

pub fn from_kb(kb: usize) -> Result<Self, PipelineError>

Creates a chunk size from kilobytes

Convenience method for creating chunk sizes in KB units.

§Arguments
  • kb - Size in kilobytes
§Returns
  • Ok(ChunkSize) - Valid chunk size
  • Err(PipelineError) - If resulting size is out of bounds
§Examples
Source

pub fn from_mb(mb: usize) -> Result<Self, PipelineError>

Creates a chunk size from megabytes

Convenience method for creating chunk sizes in MB units.

§Arguments
  • mb - Size in megabytes
§Returns
  • Ok(ChunkSize) - Valid chunk size
  • Err(PipelineError) - If resulting size is out of bounds
§Examples
Source

pub fn bytes(&self) -> usize

Gets the chunk size in bytes

§Returns

The size in bytes as a usize

Source

pub fn as_bytes(&self) -> usize

Gets the size in bytes (alias for test framework compatibility)

Source

pub fn kilobytes(&self) -> f64

Gets the size in kilobytes

Source

pub fn megabytes(&self) -> f64

Gets the size in megabytes

Source

pub fn optimal_for_file_size(file_size: u64) -> Self

Calculates the optimal chunk size based on file size

This method implements an empirically-optimized strategy based on comprehensive benchmark results across file sizes from 5MB to 2GB.

§Empirical Optimization Results
  • 100MB files: 16MB chunks optimal (vs 2MB adaptive = +43.7% performance)
  • 500MB files: 16MB chunks optimal (vs 4MB adaptive = +56.2% performance)
  • 2GB files: 128MB chunks optimal (current algorithm validated)
  • Small files: Current algorithm performing reasonably well
Source

pub fn chunks_needed_for_file(&self, file_size: u64) -> u64

Calculates the number of chunks needed for a given file size

Source

pub fn is_optimal_for_file(&self, file_size: u64) -> bool

Checks if this chunk size is optimal for the given file size

Source

pub fn adjust_for_memory( &self, available_memory: usize, max_parallel_chunks: usize, ) -> Result<Self, PipelineError>

Adjusts the chunk size based on available memory

Source

pub fn validate_user_input( user_chunk_size_mb: usize, file_size: u64, ) -> Result<usize, String>

Validates user-provided chunk size input with sanity checks Returns validated chunk size in bytes or error message

Source

pub fn strategy_description(file_size: u64) -> &'static str

Returns a description of the chunk size strategy for the given file size

Trait Implementations§

Source§

impl Clone for ChunkSize

Source§

fn clone(&self) -> ChunkSize

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChunkSize

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ChunkSize

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ChunkSize

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ChunkSize

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for ChunkSize

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ChunkSize

Source§

fn cmp(&self, other: &ChunkSize) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ChunkSize

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for ChunkSize

Source§

fn partial_cmp(&self, other: &ChunkSize) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for ChunkSize

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for ChunkSize

Source§

impl Eq for ChunkSize

Source§

impl StructuralPartialEq for ChunkSize

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,