Struct Flags 

pub struct Flags { /* private fields */ }

Implementations

impl Flags

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl Flags

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

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

Converts the given bytes directly into the bitfield struct.

impl Flags

pub fn signature_type(&self) -> <SignatureType as Specifier>::InOut

Returns the value of signature_type.

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

Returns the value of signature_type.

Errors

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

pub fn with_signature_type( self, new_val: <SignatureType as Specifier>::InOut, ) -> Self

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

Panics

If the given value is out of bounds for signature_type.

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

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

Errors

If the given value is out of bounds for signature_type.

pub fn set_signature_type( &mut self, new_val: <SignatureType as Specifier>::InOut, )

Sets the value of signature_type to the given value.

Panics

If the given value is out of bounds for signature_type.

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

Sets the value of signature_type to the given value.

Errors

If the given value is out of bounds for signature_type.

pub fn encryption_type(&self) -> <EncryptionType as Specifier>::InOut

Returns the value of encryption_type.

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

Returns the value of encryption_type.

Errors

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

pub fn with_encryption_type( self, new_val: <EncryptionType as Specifier>::InOut, ) -> Self

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

Panics

If the given value is out of bounds for encryption_type.

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

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

Errors

If the given value is out of bounds for encryption_type.

pub fn set_encryption_type( &mut self, new_val: <EncryptionType as Specifier>::InOut, )

Sets the value of encryption_type to the given value.

Panics

If the given value is out of bounds for encryption_type.

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

Sets the value of encryption_type to the given value.

Errors

If the given value is out of bounds for encryption_type.

pub fn receiver_type(&self) -> <ReceiverType as Specifier>::InOut

Returns the value of receiver_type.

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

Returns the value of receiver_type.

Errors

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

pub fn with_receiver_type( self, new_val: <ReceiverType as Specifier>::InOut, ) -> Self

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

Panics

If the given value is out of bounds for receiver_type.

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

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

Errors

If the given value is out of bounds for receiver_type.

pub fn set_receiver_type(&mut self, new_val: <ReceiverType as Specifier>::InOut)

Sets the value of receiver_type to the given value.

Panics

If the given value is out of bounds for receiver_type.

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

Sets the value of receiver_type to the given value.

Errors

If the given value is out of bounds for receiver_type.

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

Returns the value of is_bounce_back.

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

Returns the value of is_bounce_back.

Errors

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

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

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

Panics

If the given value is out of bounds for is_bounce_back.

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

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

Errors

If the given value is out of bounds for is_bounce_back.

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

Sets the value of is_bounce_back to the given value.

Panics

If the given value is out of bounds for is_bounce_back.

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

Sets the value of is_bounce_back to the given value.

Errors

If the given value is out of bounds for is_bounce_back.

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

Returns the value of has_checksum.

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

Returns the value of has_checksum.

Errors

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

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

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

Panics

If the given value is out of bounds for has_checksum.

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

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

Errors

If the given value is out of bounds for has_checksum.

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

Sets the value of has_checksum to the given value.

Panics

If the given value is out of bounds for has_checksum.

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

Sets the value of has_checksum to the given value.

Errors

If the given value is out of bounds for has_checksum.

Trait Implementations

impl BinRead for Flags

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 Flags

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<W>(&self, writer: &mut W) -> Result<(), Error>

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

Write Self to the writer using default 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_ne<W>(&self, writer: &mut W) -> Result<(), Error>

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

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

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

where W: Write + Seek, Self: WriteEndian,

Write Self to the writer using the given arguments.

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.

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

where W: Write + Seek,

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

impl CheckTotalSizeMultipleOf8 for Flags

type Size = TotalSize<BitCount<#[derive(BinWrite, BinRead, Clone, Copy, Debug, PartialEq)] #[bw(map = |&x| Self::into_bytes(x))] #[br(map = Self::from_bytes)] pub struct Flags { pub signature_type: SignatureType, // 2 bit pub encryption_type: EncryptionType, // 1 bit pub receiver_type: ReceiverType, // 2 bit pub is_bounce_back: bool, // 1 bit pub has_checksum: bool, // 1 bit #[allow(unused)] unused_2: bool, }>>

impl Clone for Flags

fn clone(&self) -> Flags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flags

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

Formats the value using the given formatter.

impl Default for Flags

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Flags

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<[u8; 1]> for Flags

fn from(bytes: [u8; 1]) -> Self

Converts to this type from the input type.

impl From<Flags> for [u8; 1]

fn from(bytes: Flags) -> Self

Converts to this type from the input type.

impl PartialEq for Flags

fn eq(&self, other: &Flags) -> 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 Flags

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

The endianness of the type.

impl Serialize for Flags

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl WriteEndian for Flags

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

The endianness of the type.

impl Copy for Flags

impl StructuralPartialEq for Flags