Struct smash_arc::HashToIndex

pub struct HashToIndex { /* fields omitted */ }

A mapping from a hash to an index into another list, used for the hash lookup tables in the format

Implementations

impl HashToIndex

pub fn hash40(&self) -> Hash40

impl HashToIndex

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl HashToIndex

pub const fn into_bytes(self) -> [u8; 8]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 8]) -> Self

Converts the given bytes directly into the bitfield struct.

impl HashToIndex

pub fn hash(&self) -> <u32 as Specifier>::InOut

Returns the value of hash.

pub fn hash_or_err(
    &self
) -> Result<<u32 as Specifier>::InOut, InvalidBitPattern<<u32 as Specifier>::Bytes>>

Returns the value of hash.

#Errors

If the returned value contains an invalid bit pattern for hash.

pub fn with_hash(mut self: Self, new_val: <u32 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of hash set to the given value.

#Panics

If the given value is out of bounds for hash.

pub fn with_hash_checked(
    mut self: Self,
    new_val: <u32 as Specifier>::InOut
) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of hash set to the given value.

#Errors

If the given value is out of bounds for hash.

pub fn set_hash(&mut self, new_val: <u32 as Specifier>::InOut)

Sets the value of hash to the given value.

#Panics

If the given value is out of bounds for hash.

pub fn set_hash_checked(
    &mut self,
    new_val: <u32 as Specifier>::InOut
) -> Result<(), OutOfBounds>

Sets the value of hash to the given value.

#Errors

If the given value is out of bounds for hash.

pub fn length(&self) -> <u8 as Specifier>::InOut

Returns the value of length.

pub fn length_or_err(
    &self
) -> Result<<u8 as Specifier>::InOut, InvalidBitPattern<<u8 as Specifier>::Bytes>>

Returns the value of length.

#Errors

If the returned value contains an invalid bit pattern for length.

pub fn with_length(mut self: Self, new_val: <u8 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of length set to the given value.

#Panics

If the given value is out of bounds for length.

pub fn with_length_checked(
    mut self: Self,
    new_val: <u8 as Specifier>::InOut
) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of length set to the given value.

#Errors

If the given value is out of bounds for length.

pub fn set_length(&mut self, new_val: <u8 as Specifier>::InOut)

Sets the value of length to the given value.

#Panics

If the given value is out of bounds for length.

pub fn set_length_checked(
    &mut self,
    new_val: <u8 as Specifier>::InOut
) -> Result<(), OutOfBounds>

Sets the value of length to the given value.

#Errors

If the given value is out of bounds for length.

pub fn index(&self) -> <B24 as Specifier>::InOut

Returns the value of index.

pub fn index_or_err(
    &self
) -> Result<<B24 as Specifier>::InOut, InvalidBitPattern<<B24 as Specifier>::Bytes>>

Returns the value of index.

#Errors

If the returned value contains an invalid bit pattern for index.

pub fn with_index(mut self: Self, new_val: <B24 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of index set to the given value.

#Panics

If the given value is out of bounds for index.

pub fn with_index_checked(
    mut self: Self,
    new_val: <B24 as Specifier>::InOut
) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of index set to the given value.

#Errors

If the given value is out of bounds for index.

pub fn set_index(&mut self, new_val: <B24 as Specifier>::InOut)

Sets the value of index to the given value.

#Panics

If the given value is out of bounds for index.

pub fn set_index_checked(
    &mut self,
    new_val: <B24 as Specifier>::InOut
) -> Result<(), OutOfBounds>

Sets the value of index to the given value.

#Errors

If the given value is out of bounds for index.

Trait Implementations

impl BinRead for HashToIndex

type Args = ()

The type of arguments needed to be supplied in order to read this type, usually a tuple.

fn read_options<R: Read + Seek>(
    __binread_generated_var_reader: &mut R,
    __binread_generated_var_options: &ReadOptions,
    __binread_generated_var_arguments: Self::Args
) -> BinResult<Self>

Read the type from the reader

fn after_parse<R: Read + Seek>(
    &mut self,
    __binread_generated_var_reader: &mut R,
    __binread_generated_var_options: &ReadOptions,
    __binread_generated_var_arguments: Self::Args
) -> BinResult<()>

pub fn read<R>(reader: &mut R) -> Result<Self, Error> where
    R: Read + Seek, 

Read the type from the reader while assuming no arguments have been passed

pub fn read_args<R>(reader: &mut R, args: Self::Args) -> Result<Self, Error> where
    R: Read + Seek, 

Read the type from the reader using the specified arguments

pub fn args_default() -> Option<Self::Args>

The default arguments to be used when using the read shortcut method. Override this for any type that optionally requries arguments

impl CheckTotalSizeMultipleOf8 for HashToIndex

type Size = TotalSize<[(); 0]>

impl Clone for HashToIndex

fn clone(&self) -> HashToIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for HashToIndex

impl Debug for HashToIndex

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

Formats the value using the given formatter.

impl From<&'_ HashToIndex> for Hash40

fn from(hash_index: &HashToIndex) -> Self

Performs the conversion.

impl From<HashToIndex> for Hash40

fn from(hash_index: HashToIndex) -> Self

Performs the conversion.