Struct body_image::Tunables

pub struct Tunables { /* fields omitted */ }

A collection of size limits and performance tuning constants. Setters are available via Tuner.

Implementations

impl Tunables

pub fn new() -> Tunables

Construct with default values.

pub fn max_body_ram(&self) -> u64

Return the maximum body size in bytes allowed in RAM, e.g. before writing to a temporary file, or memory mapping instead of direct, bulk read. Default: 192 KiB.

pub fn max_body(&self) -> u64

Return the maximum body size in bytes allowed in any form (RAM or file). Default: 1 GiB.

pub fn buffer_size_ram(&self) -> usize

Return the buffer size in bytes to use when buffering to RAM. Default: 8 KiB.

pub fn buffer_size_fs(&self) -> usize

Return the buffer size in bytes to use when buffering to/from the file-system. Default: 64 KiB.

pub fn size_estimate_deflate(&self) -> u16

Return the size estimate, as an integer multiple of the encoded buffer size, for the deflate compression algorithm. Default: 4.

pub fn size_estimate_gzip(&self) -> u16

Return the size estimate, as an integer multiple of the encoded buffer size, for the gzip compression algorithm. Default: 5.

pub fn size_estimate_brotli(&self) -> u16

Return the size estimate, as an integer multiple of the encoded buffer size, for the Brotli compression algorithm. Default: 6.

pub fn temp_dir(&self) -> &Path

Return the directory path in which to write temporary (BodyImage) files. Default: std::env::temp_dir()

pub fn temp_dir_rc(&self) -> Arc<Path>

Return a reference to the directory path in which to write temporary (BodyImage) files. Default: std::env::temp_dir()

Trait Implementations

impl Clone for Tunables

fn clone(&self) -> Tunables

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tunables

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

Formats the value using the given formatter.

impl Default for Tunables

fn default() -> Self

Returns the “default value” for a type.