Struct FileInfoFlags

pub struct FileInfoFlags { /* private fields */ }

Implementations

impl FileInfoFlags

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl FileInfoFlags

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 FileInfoFlags

pub fn unused(&self) -> <B4 as Specifier>::InOut

Returns the value of unused.

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

Returns the value of unused.

#Errors

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

pub fn with_unused(self, new_val: <B4 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for unused.

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

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

#Errors

If the given value is out of bounds for unused.

pub fn set_unused(&mut self, new_val: <B4 as Specifier>::InOut)

Sets the value of unused to the given value.

#Panics

If the given value is out of bounds for unused.

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

Sets the value of unused to the given value.

#Errors

If the given value is out of bounds for unused.

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

Returns the value of is_redirect.

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

Returns the value of is_redirect.

#Errors

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

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

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

#Panics

If the given value is out of bounds for is_redirect.

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

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

#Errors

If the given value is out of bounds for is_redirect.

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

Sets the value of is_redirect to the given value.

#Panics

If the given value is out of bounds for is_redirect.

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

Sets the value of is_redirect to the given value.

#Errors

If the given value is out of bounds for is_redirect.

pub fn unused2(&self) -> <B7 as Specifier>::InOut

Returns the value of unused2.

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

Returns the value of unused2.

#Errors

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

pub fn with_unused2(self, new_val: <B7 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for unused2.

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

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

#Errors

If the given value is out of bounds for unused2.

pub fn set_unused2(&mut self, new_val: <B7 as Specifier>::InOut)

Sets the value of unused2 to the given value.

#Panics

If the given value is out of bounds for unused2.

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

Sets the value of unused2 to the given value.

#Errors

If the given value is out of bounds for unused2.

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

Returns the value of unknown1.

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

Returns the value of unknown1.

#Errors

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

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

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

#Panics

If the given value is out of bounds for unknown1.

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

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

#Errors

If the given value is out of bounds for unknown1.

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

Sets the value of unknown1 to the given value.

#Panics

If the given value is out of bounds for unknown1.

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

Sets the value of unknown1 to the given value.

#Errors

If the given value is out of bounds for unknown1.

pub fn padding3(&self) -> <B2 as Specifier>::InOut

Returns the value of padding3.

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

Returns the value of padding3.

#Errors

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

pub fn with_padding3(self, new_val: <B2 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for padding3.

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

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

#Errors

If the given value is out of bounds for padding3.

pub fn set_padding3(&mut self, new_val: <B2 as Specifier>::InOut)

Sets the value of padding3 to the given value.

#Panics

If the given value is out of bounds for padding3.

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

Sets the value of padding3 to the given value.

#Errors

If the given value is out of bounds for padding3.

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

Returns the value of is_regional.

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

Returns the value of is_regional.

#Errors

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

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

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

#Panics

If the given value is out of bounds for is_regional.

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

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

#Errors

If the given value is out of bounds for is_regional.

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

Sets the value of is_regional to the given value.

#Panics

If the given value is out of bounds for is_regional.

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

Sets the value of is_regional to the given value.

#Errors

If the given value is out of bounds for is_regional.

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

Returns the value of is_localized.

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

Returns the value of is_localized.

#Errors

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

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

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

#Panics

If the given value is out of bounds for is_localized.

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

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

#Errors

If the given value is out of bounds for is_localized.

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

Sets the value of is_localized to the given value.

#Panics

If the given value is out of bounds for is_localized.

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

Sets the value of is_localized to the given value.

#Errors

If the given value is out of bounds for is_localized.

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

Returns the value of unused3.

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

Returns the value of unused3.

#Errors

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

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

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

#Panics

If the given value is out of bounds for unused3.

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

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

#Errors

If the given value is out of bounds for unused3.

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

Sets the value of unused3 to the given value.

#Panics

If the given value is out of bounds for unused3.

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

Sets the value of unused3 to the given value.

#Errors

If the given value is out of bounds for unused3.

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

Returns the value of unknown2.

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

Returns the value of unknown2.

#Errors

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

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

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

#Panics

If the given value is out of bounds for unknown2.

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

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

#Errors

If the given value is out of bounds for unknown2.

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

Sets the value of unknown2 to the given value.

#Panics

If the given value is out of bounds for unknown2.

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

Sets the value of unknown2 to the given value.

#Errors

If the given value is out of bounds for unknown2.

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

Returns the value of unknown3.

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

Returns the value of unknown3.

#Errors

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

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

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

#Panics

If the given value is out of bounds for unknown3.

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

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

#Errors

If the given value is out of bounds for unknown3.

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

Sets the value of unknown3 to the given value.

#Panics

If the given value is out of bounds for unknown3.

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

Sets the value of unknown3 to the given value.

#Errors

If the given value is out of bounds for unknown3.

pub fn unused4(&self) -> <B10 as Specifier>::InOut

Returns the value of unused4.

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

Returns the value of unused4.

#Errors

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

pub fn with_unused4(self, new_val: <B10 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for unused4.

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

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

#Errors

If the given value is out of bounds for unused4.

pub fn set_unused4(&mut self, new_val: <B10 as Specifier>::InOut)

Sets the value of unused4 to the given value.

#Panics

If the given value is out of bounds for unused4.

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

Sets the value of unused4 to the given value.

#Errors

If the given value is out of bounds for unused4.

Trait Implementations

impl BinRead for FileInfoFlags

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 FileInfoFlags

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

impl Clone for FileInfoFlags

fn clone(&self) -> FileInfoFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileInfoFlags

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

Formats the value using the given formatter.

impl Hash for FileInfoFlags

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FileInfoFlags

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl ReadEndian for FileInfoFlags

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

The endianness of the type.

impl Copy for FileInfoFlags

impl Eq for FileInfoFlags

impl StructuralPartialEq for FileInfoFlags