Struct binjs_io::io::statistics::PerUserExtensibleKind

pub struct PerUserExtensibleKind<T> {
    pub floats: T,
    pub unsigned_longs: T,
    pub property_keys: T,
    pub identifier_names: T,
    pub string_literals: T,
    pub list_lengths: T,
}

During compression, we typically deal with both grammar-fixed data (e.g. the list of possible values in a string enum) and user-extensible data (e.g. string literals).

This container is meant to store data associated with user-extensible data. This serves typically to store per-kind compression settings, per-kind compressed/decompressed data, dictionaries, etc.

Fields

floats: T

unsigned_longs: T

property_keys: T

identifier_names: T

string_literals: T

list_lengths: T

Methods

impl<T> PerUserExtensibleKind<T>

pub fn with<F>(f: F) -> Self where
    F: Fn(&str) -> T, 

Initialize a new PerUserExtensibleKind.

pub fn into_with<F, U>(self, f: F) -> PerUserExtensibleKind<U> where
    F: Fn(&str, T) -> U, 

Convert a PerUserExtensibleKind into another one.

pub fn iter(&self) -> impl Iterator<Item = (&'static str, &T)>

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&'static str, &mut T)>

pub fn into_iter(self) -> impl Iterator<Item = (&'static str, T)>

pub fn get(&self, field_name: &str) -> Option<&T>

Access a field by its name.

This method is typically used to simplify parsing a file that contains sections explicitly labelled "bools", "floats", etc. In such case, field_name is expected to be a user input.

Return None if field_name is not one of the field names.

pub fn get_mut(&mut self, field_name: &str) -> Option<&mut T>

pub fn get_mut_b(&mut self, field_name: &[u8]) -> Option<&mut T>

Access a field by its name, specified as a sequence of bytes.

This method is typically used to simplify parsing a file that contains sections explicitly labelled "bools", "floats", etc. In such case, field_name is expected to be a user input.

Return None if field_name is not one of the field names.

pub fn get_b(&self, field_name: &[u8]) -> Option<&T>

impl PerUserExtensibleKind<Writer<LengthWriter>>

pub fn into_statistics(self) -> PerUserExtensibleKind<Bytes>

Finalize and return the number of compressed bytes written.

This number is determined by examining the underlying LengthWriter.

Trait Implementations

impl<T: Add<Output = T>> Add<PerUserExtensibleKind<T>> for PerUserExtensibleKind<T>

type Output = PerUserExtensibleKind<T>

The resulting type after applying the + operator.

fn add(self, rhs: PerUserExtensibleKind<T>) -> PerUserExtensibleKind<T>

Performs the + operation.

impl<T: AddAssign> AddAssign<PerUserExtensibleKind<T>> for PerUserExtensibleKind<T>

fn add_assign(&mut self, rhs: PerUserExtensibleKind<T>)

Performs the += operation.

impl<T: Clone> Clone for PerUserExtensibleKind<T>

fn clone(&self) -> PerUserExtensibleKind<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PerUserExtensibleKind<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for PerUserExtensibleKind<T>

fn default() -> PerUserExtensibleKind<T>

Returns the "default value" for a type.

impl Display for PerUserExtensibleKind<BytesAndInstances>

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.