Struct smash_arc::FileDataFlags

pub struct FileDataFlags { /* fields omitted */ }

Flags indicating the type of compression, if any, to use

Implementations

impl FileDataFlags

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl FileDataFlags

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

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

Converts the given bytes directly into the bitfield struct.

impl FileDataFlags

pub fn compressed(&self) -> <bool as Specifier>::InOut

Returns the value of compressed.

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

Returns the value of compressed.

#Errors

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

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

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

#Panics

If the given value is out of bounds for compressed.

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

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

#Errors

If the given value is out of bounds for compressed.

pub fn set_compressed(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of compressed to the given value.

#Panics

If the given value is out of bounds for compressed.

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

Sets the value of compressed to the given value.

#Errors

If the given value is out of bounds for compressed.

pub fn use_zstd(&self) -> <bool as Specifier>::InOut

Returns the value of use_zstd.

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

Returns the value of use_zstd.

#Errors

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

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

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

#Panics

If the given value is out of bounds for use_zstd.

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

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

#Errors

If the given value is out of bounds for use_zstd.

pub fn set_use_zstd(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of use_zstd to the given value.

#Panics

If the given value is out of bounds for use_zstd.

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

Sets the value of use_zstd to the given value.

#Errors

If the given value is out of bounds for use_zstd.

pub fn unk(&self) -> <B30 as Specifier>::InOut

Returns the value of unk.

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

Returns the value of unk.

#Errors

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

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

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

#Panics

If the given value is out of bounds for unk.

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

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

#Errors

If the given value is out of bounds for unk.

pub fn set_unk(&mut self, new_val: <B30 as Specifier>::InOut)

Sets the value of unk to the given value.

#Panics

If the given value is out of bounds for unk.

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

Sets the value of unk to the given value.

#Errors

If the given value is out of bounds for unk.

Trait Implementations

impl BinRead for FileDataFlags

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 FileDataFlags

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

impl Clone for FileDataFlags

fn clone(&self) -> FileDataFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FileDataFlags

impl Debug for FileDataFlags

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

Formats the value using the given formatter.

impl Eq for FileDataFlags

impl Hash for FileDataFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<FileDataFlags> for FileDataFlags

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

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

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

This method tests for !=.

impl StructuralEq for FileDataFlags

impl StructuralPartialEq for FileDataFlags