Struct MemorySettings

#[repr(C)]
pub struct MemorySettings {
    pub preallocated_parsing_buffer_size: usize,
    pub max_allowed_memory_usage: usize,
}

Specifies the memory settings for HtmlRewriter.

Fields

preallocated_parsing_buffer_size: usize

Specifies the number of bytes that should be preallocated on HtmlRewriter instantiation for the internal parsing buffer.

In some cases (e.g. when rewriter encounters a start tag represented by two or more input chunks) the rewriter needs to buffer input content.

Internal parsing buffer is used in such cases. Reallocations and, thus, performance degradation can be avoided by preallocating the buffer ahead of time. As a drawback of this approach, every instance of the rewriter will consume the preallocated amount of memory.

It’s up to the user to adjust the limit according to their environment limitations.

Default

1024 bytes when constructed with MemorySettings::new().

max_allowed_memory_usage: usize

Sets a hard limit in bytes on memory consumption of a HtmlRewriter instance.

Rewriter’s write and end methods will error if this limit is exceeded.

Note, that value doesn’t reflect the exact threshold after which the rewriter will bailout. It is impossible to account for all the memory consumed without a significant performance penalty. So, instead, we try to provide the best approximation by measuring the memory consumed by internal buffers that grow depending on the input.

Default

std::usize::MAX when constructed with MemorySettings::new().

Implementations

impl MemorySettings

pub fn new() -> MemorySettings

Create a new MemorySettings with default values.

Trait Implementations

impl Default for MemorySettings

fn default() -> Self

Returns the “default value” for a type.