Struct ssbh_lib::formats::meshex::EntryFlag

pub struct EntryFlag { /* private fields */ }

Implementations

impl EntryFlag

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl EntryFlag

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

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

Converts the given bytes directly into the bitfield struct.

impl EntryFlag

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

Returns the value of draw_model.

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

Returns the value of draw_model.

#Errors

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

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

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

#Panics

If the given value is out of bounds for draw_model.

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

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

#Errors

If the given value is out of bounds for draw_model.

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

Sets the value of draw_model to the given value.

#Panics

If the given value is out of bounds for draw_model.

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

Sets the value of draw_model to the given value.

#Errors

If the given value is out of bounds for draw_model.

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

Returns the value of cast_shadow.

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

Returns the value of cast_shadow.

#Errors

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

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

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

#Panics

If the given value is out of bounds for cast_shadow.

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

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

#Errors

If the given value is out of bounds for cast_shadow.

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

Sets the value of cast_shadow to the given value.

#Panics

If the given value is out of bounds for cast_shadow.

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

Sets the value of cast_shadow to the given value.

#Errors

If the given value is out of bounds for cast_shadow.

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

Returns the value of unk3.

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

Returns the value of unk3.

#Errors

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

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

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

#Panics

If the given value is out of bounds for unk3.

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

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

#Errors

If the given value is out of bounds for unk3.

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

Sets the value of unk3 to the given value.

#Panics

If the given value is out of bounds for unk3.

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

Sets the value of unk3 to the given value.

#Errors

If the given value is out of bounds for unk3.

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

Returns the value of unk4.

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

Returns the value of unk4.

#Errors

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

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

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

#Panics

If the given value is out of bounds for unk4.

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

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

#Errors

If the given value is out of bounds for unk4.

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

Sets the value of unk4 to the given value.

#Panics

If the given value is out of bounds for unk4.

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

Sets the value of unk4 to the given value.

#Errors

If the given value is out of bounds for unk4.

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

Returns the value of unk5.

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

Returns the value of unk5.

#Errors

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

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

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

#Panics

If the given value is out of bounds for unk5.

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

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

#Errors

If the given value is out of bounds for unk5.

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

Sets the value of unk5 to the given value.

#Panics

If the given value is out of bounds for unk5.

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

Sets the value of unk5 to the given value.

#Errors

If the given value is out of bounds for unk5.

Trait Implementations

impl BinRead for EntryFlag

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.

impl CheckFillsUnalignedBits for EntryFlag

type CheckType = [(); 1]

impl Clone for EntryFlag

fn clone(&self) -> EntryFlag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntryFlag

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

Formats the value using the given formatter.

impl PartialEq for EntryFlag

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ReadEndian for EntryFlag

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

The endianness of the type.

impl SsbhWrite for EntryFlag

fn ssbh_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Result<()>

Writes the byte representation of self to writer. data_ptr is assumed to be the absolute offset where the next data stored behind an offset will be written. Struct that contains no offsets as fields can skip updating data_ptr.

fn alignment_in_bytes() -> u64

The alignment for pointers of this type, which is useful for offset calculations.

fn size_in_bytes(&self) -> u64

The offset in bytes between successive elements in an array of this type. This should include any alignment or padding.

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek,

Writes the byte representation of self to writer. This is a convenience method for ssbh_write that handles initializing the data pointer.

impl Copy for EntryFlag

impl Eq for EntryFlag

impl StructuralPartialEq for EntryFlag