StreamingParserConfig

Struct StreamingParserConfig 

Source
pub struct StreamingParserConfig {
    pub max_line_length: usize,
    pub max_indent_depth: usize,
    pub buffer_size: usize,
    pub timeout: Option<Duration>,
}
Expand description

Configuration options for the streaming parser.

Controls memory limits, buffer sizes, and timeout behavior.

§Examples

§Default Configuration

use hedl_stream::StreamingParserConfig;

let config = StreamingParserConfig::default();
assert_eq!(config.max_line_length, 1_000_000);
assert_eq!(config.max_indent_depth, 100);
assert_eq!(config.buffer_size, 64 * 1024);
assert_eq!(config.timeout, None);

§Custom Configuration for Large Files

use hedl_stream::StreamingParserConfig;

let config = StreamingParserConfig {
    max_line_length: 10_000_000,  // 10MB lines
    max_indent_depth: 1000,        // Deep nesting
    buffer_size: 256 * 1024,       // 256KB buffer
    timeout: None,                 // No timeout
};

§Configuration for Untrusted Input

use hedl_stream::StreamingParserConfig;
use std::time::Duration;

let config = StreamingParserConfig {
    max_line_length: 100_000,           // Limit line length
    max_indent_depth: 50,                // Limit nesting
    buffer_size: 32 * 1024,              // Smaller buffer
    timeout: Some(Duration::from_secs(10)), // 10 second timeout
};

Fields§

§max_line_length: usize

Maximum line length in bytes.

Lines exceeding this length will cause a parsing error. This protects against malformed input with extremely long lines that could exhaust memory.

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

§max_indent_depth: usize

Maximum indentation depth.

Indentation levels exceeding this depth will cause a parsing error. This protects against deeply nested structures that could cause stack overflow or performance issues.

Default: 100 levels

§buffer_size: usize

Buffer size for reading input.

Larger buffers can improve performance for large files by reducing the number of system calls, but use more memory.

Default: 64KB

§timeout: Option<Duration>

Timeout for parsing operations.

If set, the parser will return a StreamError::Timeout if parsing takes longer than the specified duration. This protects against infinite loops from malicious or malformed input.

Set to None to disable timeout checking (default for trusted input).

Default: None (no timeout)

§Performance Note

Timeout checking is performed periodically (every 100 operations) to minimize overhead. For very fast parsing, the actual timeout may slightly exceed the configured limit.

Trait Implementations§

Source§

impl Clone for StreamingParserConfig

Source§

fn clone(&self) -> StreamingParserConfig

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 StreamingParserConfig

Source§

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

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

impl Default for StreamingParserConfig

Source§

fn default() -> Self

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

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.