Struct vpk0::LzssSettings

pub struct LzssSettings {
    pub offset_bits: usize,
    pub length_bits: usize,
    pub max_uncoded: usize,
}

Configure the LZSS encoding that underlies vpk0 compression

You can set the three key LZSS parameters: dictionary size, maximum match size, and minimum match size. When using new or struct literals, you are setting the total number of bits for the dictionary or max match, but the minimum match size is in bytes. If you’d prefer to set everything in terms of bytes, you can use byte_sized. Note that any non-power-of-two byte sizes will be rounded up for the dictionary and max match.

By default:

Parameter	Field	Bit Size	Bytes
Dictionary	offset_bits	16	65536
Max Match	length_bits	8	256
Min Match	max_uncoded		2

These settings were used by Nintendo when compressing the files in Super Smash Bros. 64.

Fields

offset_bits: usize

number of bits for move back (window size)

length_bits: usize

number of bits for copying (max match encoded)

max_uncoded: usize

max number of bytes not encoded

Implementations

impl LzssSettings

pub const fn new(
    offset_bits: usize,
    size_bits: usize,
    max_uncoded: usize
) -> Self

pub const fn byte_sized(
    dictionary: usize,
    max_match: usize,
    min_match: usize
) -> Self

Trait Implementations

impl Clone for LzssSettings

fn clone(&self) -> LzssSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for LzssSettings

impl Debug for LzssSettings

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

Formats the value using the given formatter.

impl Default for LzssSettings

fn default() -> Self

Returns the “default value” for a type.

impl Eq for LzssSettings

impl PartialEq<LzssSettings> for LzssSettings

fn eq(&self, other: &LzssSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LzssSettings) -> bool

This method tests for !=.

impl StructuralEq for LzssSettings

impl StructuralPartialEq for LzssSettings