Struct DeckError 

pub struct DeckError { /* private fields */ }

A deck error, packing an error type and the offending card code.

Implementations

impl DeckError

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl DeckError

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 DeckError

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

Returns the value of code. The offending card code.

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

Returns the value of code.

Errors

If the returned value contains an invalid bit pattern for code. The offending card code.

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

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

Panics

If the given value is out of bounds for code. The offending card code.

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

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

Errors

If the given value is out of bounds for code. The offending card code.

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

Sets the value of code to the given value.

Panics

If the given value is out of bounds for code. The offending card code.

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

Sets the value of code to the given value.

Errors

If the given value is out of bounds for code. The offending card code.

pub fn error_type(&self) -> <DeckErrorType as Specifier>::InOut

Returns the value of error_type. The error type.

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

Returns the value of error_type.

Errors

If the returned value contains an invalid bit pattern for error_type. The error type.

pub fn with_error_type( self, new_val: <DeckErrorType as Specifier>::InOut, ) -> Self

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

Panics

If the given value is out of bounds for error_type. The error type.

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

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

Errors

If the given value is out of bounds for error_type. The error type.

pub fn set_error_type(&mut self, new_val: <DeckErrorType as Specifier>::InOut)

Sets the value of error_type to the given value.

Panics

If the given value is out of bounds for error_type. The error type.

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

Sets the value of error_type to the given value.

Errors

If the given value is out of bounds for error_type. The error type.

Trait Implementations

impl BinRead for DeckError

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 DeckError

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_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.

impl CheckTotalSizeMultipleOf8 for DeckError

type Size = TotalSize<BitCount</// A deck error, packing an error type and the offending card code. #[bitfield] #[derive(BinRead, BinWrite, Debug, Clone, Copy, PartialEq, Eq)] #[br(map = Self::from_bytes)] #[bw(map = |&x| Self::into_bytes(x))] #[repr(u32)] pub struct DeckError { /// The offending card code. pub code: modular_bitfield::specifiers::B28, /// The error type. pub error_type: DeckErrorType, }>>

impl Clone for DeckError

fn clone(&self) -> DeckError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DeckError

impl Debug for DeckError

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

Formats the value using the given formatter.

impl Display for DeckError

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

Formats the value using the given formatter.

impl Eq for DeckError

impl Error for DeckError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DeckError> for [u8; 4]

fn from(bytes: DeckError) -> Self

Converts to this type from the input type.

impl From<DeckError> for u32

where BitCount<{ _ }>: IsU32Compatible,

fn from(__bf_bitfield: DeckError) -> Self

Converts to this type from the input type.

impl From<[u8; 4]> for DeckError

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

Converts to this type from the input type.

impl From<u32> for DeckError

where BitCount<{ _ }>: IsU32Compatible,

fn from(__bf_prim: u32) -> Self

Converts to this type from the input type.

impl PartialEq for DeckError

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

Equality operator ==.

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

Inequality operator !=.

impl ReadEndian for DeckError

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

The endianness of the type.

impl StructuralPartialEq for DeckError

impl WriteEndian for DeckError

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

The endianness of the type.