Skip to main content

MemoryLimits

Struct MemoryLimits 

Source
pub struct MemoryLimits {
    pub max_buffer_size: usize,
    pub max_line_length: usize,
    pub enable_buffer_pooling: bool,
    pub max_pool_size: usize,
}
Expand description

Memory limits for buffer management.

Controls maximum buffer sizes, line lengths, and pool configuration to prevent unbounded memory growth and handle memory-constrained environments.

§Examples

§Default Configuration

use hedl_stream::MemoryLimits;

let limits = MemoryLimits::default();
assert_eq!(limits.max_buffer_size, 1024 * 1024);
assert_eq!(limits.max_line_length, 1_000_000);
assert_eq!(limits.enable_buffer_pooling, true);
assert_eq!(limits.max_pool_size, 10);

§Memory-Constrained Configuration

use hedl_stream::MemoryLimits;

let limits = MemoryLimits {
    max_buffer_size: 64 * 1024,       // 64KB max I/O buffer
    max_line_length: 100_000,         // 100KB max line
    enable_buffer_pooling: false,     // Disable pooling
    max_pool_size: 0,
};

§High-Throughput Configuration

use hedl_stream::MemoryLimits;

let limits = MemoryLimits {
    max_buffer_size: 2 * 1024 * 1024, // 2MB max I/O buffer
    max_line_length: 10_000_000,      // 10MB max line
    enable_buffer_pooling: true,
    max_pool_size: 50,                // Large pool
};

Fields§

§max_buffer_size: usize

Maximum I/O buffer size in bytes.

Controls the size of the read buffer used by BufReader. Larger buffers reduce syscall overhead but use more memory.

Default: 1MB

§max_line_length: usize

Maximum line length in bytes.

Lines exceeding this length cause a parsing error. This protects against malformed input with extremely long lines.

Default: 1,000,000 bytes (1MB)

§enable_buffer_pooling: bool

Enable buffer pooling.

When true, reuses string and value buffers across parsing operations. Reduces allocation overhead in high-throughput scenarios.

Default: true

§max_pool_size: usize

Maximum number of buffers to pool.

Limits pool growth to prevent unbounded memory usage. Only effective when enable_buffer_pooling is true.

Default: 10 buffers

Implementations§

Source§

impl MemoryLimits

Source

pub fn embedded() -> Self

Configuration for embedded systems or memory-constrained environments.

Uses minimal buffer sizes and disables pooling to minimize memory footprint.

§Examples
use hedl_stream::MemoryLimits;

let limits = MemoryLimits::embedded();
assert_eq!(limits.max_buffer_size, 8 * 1024);
assert_eq!(limits.enable_buffer_pooling, false);
Source

pub fn high_throughput() -> Self

Configuration for large file processing with high throughput.

Uses large buffers and extensive pooling for maximum performance.

§Examples
use hedl_stream::MemoryLimits;

let limits = MemoryLimits::high_throughput();
assert_eq!(limits.max_buffer_size, 2 * 1024 * 1024);
assert_eq!(limits.max_pool_size, 50);
Source

pub fn untrusted() -> Self

Configuration for untrusted input.

Uses conservative limits to protect against malicious input.

§Examples
use hedl_stream::MemoryLimits;

let limits = MemoryLimits::untrusted();
assert_eq!(limits.max_line_length, 100_000);

Trait Implementations§

Source§

impl Clone for MemoryLimits

Source§

fn clone(&self) -> MemoryLimits

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 MemoryLimits

Source§

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

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

impl Default for MemoryLimits

Source§

fn default() -> Self

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

impl PartialEq for MemoryLimits

Source§

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

Source§

impl Eq for MemoryLimits

Source§

impl StructuralPartialEq for MemoryLimits

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> 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, 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.