Struct physis::index::IndexHashBitfield

pub struct IndexHashBitfield { /* private fields */ }

Implementations

impl IndexHashBitfield

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl IndexHashBitfield

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 IndexHashBitfield

pub fn size(&self) -> <B1 as Specifier>::InOut

Returns the value of size.

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

Returns the value of size.

#Errors

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

pub fn with_size(self, new_val: <B1 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for size.

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

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

#Errors

If the given value is out of bounds for size.

pub fn set_size(&mut self, new_val: <B1 as Specifier>::InOut)

Sets the value of size to the given value.

#Panics

If the given value is out of bounds for size.

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

Sets the value of size to the given value.

#Errors

If the given value is out of bounds for size.

pub fn data_file_id(&self) -> <B3 as Specifier>::InOut

Returns the value of data_file_id.

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

Returns the value of data_file_id.

#Errors

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

pub fn with_data_file_id(self, new_val: <B3 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for data_file_id.

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

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

#Errors

If the given value is out of bounds for data_file_id.

pub fn set_data_file_id(&mut self, new_val: <B3 as Specifier>::InOut)

Sets the value of data_file_id to the given value.

#Panics

If the given value is out of bounds for data_file_id.

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

Sets the value of data_file_id to the given value.

#Errors

If the given value is out of bounds for data_file_id.

pub fn offset(&self) -> <B28 as Specifier>::InOut

Returns the value of offset.

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

Returns the value of offset.

#Errors

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

pub fn with_offset(self, new_val: <B28 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for offset.

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

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

#Errors

If the given value is out of bounds for offset.

pub fn set_offset(&mut self, new_val: <B28 as Specifier>::InOut)

Sets the value of offset to the given value.

#Panics

If the given value is out of bounds for offset.

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

Sets the value of offset to the given value.

#Errors

If the given value is out of bounds for offset.

Trait Implementations

impl BinRead for IndexHashBitfield

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 BinWrite for IndexHashBitfield

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_> ) -> BinResult<()>

Write Self to the writer using the given [Endian] and arguments.

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

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

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

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_> ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_> ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

impl CheckTotalSizeMultipleOf8 for IndexHashBitfield

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

impl Clone for IndexHashBitfield

fn clone(&self) -> IndexHashBitfield

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexHashBitfield

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

Formats the value using the given formatter.

impl ReadEndian for IndexHashBitfield

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

The endianness of the type.

impl Copy for IndexHashBitfield