Struct smash_arc::QuickDir

pub struct QuickDir { /* private fields */ }

Implementations

impl QuickDir

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl QuickDir

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

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; 12]) -> Self

Converts the given bytes directly into the bitfield struct.

impl QuickDir

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(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( 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 name_length(&self) -> <u8 as Specifier>::InOut

Returns the value of name_length.

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

Returns the value of name_length.

#Errors

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

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

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

#Panics

If the given value is out of bounds for name_length.

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

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

#Errors

If the given value is out of bounds for name_length.

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

Sets the value of name_length to the given value.

#Panics

If the given value is out of bounds for name_length.

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

Sets the value of name_length to the given value.

#Errors

If the given value is out of bounds for name_length.

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

Returns the value of count.

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

Returns the value of count.

#Errors

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

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

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

#Panics

If the given value is out of bounds for count.

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

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

#Errors

If the given value is out of bounds for count.

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

Sets the value of count to the given value.

#Panics

If the given value is out of bounds for count.

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

Sets the value of count to the given value.

#Errors

If the given value is out of bounds for count.

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

Returns the value of index.

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

Returns the value of index.

#Errors

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

pub fn with_index(self, new_val: <u32 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( self, new_val: <u32 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: <u32 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: <u32 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.

impl QuickDir

pub fn hash40(&self) -> Hash40

Trait Implementations

impl BinRead for QuickDir

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_> ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

fn after_parse<R>( &mut self, _: &mut R, _: Endian, _: Self::Args<'_> ) -> Result<(), Error>

where R: Read + Seek,

Runs any post-processing steps required to finalize construction of the object.

impl CheckTotalSizeMultipleOf8 for QuickDir

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

impl Clone for QuickDir

fn clone(&self) -> QuickDir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QuickDir

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

Formats the value using the given formatter.

impl ReadEndian for QuickDir

const ENDIAN: EndianKind = binrw::meta::EndianKind::None

The endianness of the type.

impl Copy for QuickDir