Trait mycelium_bitfield::FromBits

source ·

pub trait FromBits<B>: Sized {
    type Error: Display;

    const BITS: u32;

    // Required methods
    fn try_from_bits(bits: B) -> Result<Self, Self::Error>;
    fn into_bits(self) -> B;
}

Expand description

Trait implemented by values which can be converted to and from raw bits.

This trait is implemented by default for all signed and unsigned integer types, as well as for bools. It can be implemented manually for any user-defined type which has a well-defined bit-pattern representation. For enum types with unsigned integer reprs, it may also be implemented automatically using the enum_from_bits! macro.

Required Associated Types§

source

type Error: Display

The error type returned by Self::try_from_bits when an invalid bit pattern is encountered.

If all bit patterns possible in Self::BITS bits are valid bit patterns for a Self-typed value, this should generally be core::convert::Infallible.

Required Associated Constants§

source

const BITS: u32

The number of bits required to represent a value of this type.

Required Methods§

source

fn try_from_bits(bits: B) -> Result<Self, Self::Error>

Attempt to convert bits into a value of this type.

Returns

Ok(Self) if bits contained a valid bit pattern for a value of this type.
Err(Self::Error) if bits is an invalid bit pattern for a value of this type.

source

fn into_bits(self) -> B

Convert self into a raw bit representation.

In general, this will be a low-cost conversion (e.g., for enums, this is generally an as cast).

Object Safety§

This trait is not object safe.

Trait mycelium_bitfield::FromBits

Required Associated Types§

type Error: Display

Required Associated Constants§

const BITS: u32

Required Methods§

fn try_from_bits(bits: B) -> Result<Self, Self::Error>

fn into_bits(self) -> B

Object Safety§

Implementations on Foreign Types§

impl FromBits<u8> for bool

const BITS: u32 = 1u32

type Error = Infallible

fn try_from_bits(f: u8) -> Result<Self, Self::Error>

fn into_bits(self) -> u8

impl FromBits<u8> for i8

const BITS: u32 = 8u32

type Error = Infallible

fn try_from_bits(f: u8) -> Result<Self, Self::Error>

fn into_bits(self) -> u8

impl FromBits<u8> for u8

const BITS: u32 = 8u32

type Error = Infallible

fn try_from_bits(f: u8) -> Result<Self, Self::Error>

fn into_bits(self) -> u8

impl FromBits<u16> for bool

const BITS: u32 = 1u32

type Error = Infallible

fn try_from_bits(f: u16) -> Result<Self, Self::Error>

fn into_bits(self) -> u16

impl FromBits<u16> for i8

const BITS: u32 = 8u32

type Error = Infallible

fn try_from_bits(f: u16) -> Result<Self, Self::Error>

fn into_bits(self) -> u16

impl FromBits<u16> for i16

const BITS: u32 = 16u32

type Error = Infallible

fn try_from_bits(f: u16) -> Result<Self, Self::Error>

fn into_bits(self) -> u16

impl FromBits<u16> for u8

const BITS: u32 = 8u32

type Error = Infallible

fn try_from_bits(f: u16) -> Result<Self, Self::Error>

fn into_bits(self) -> u16

impl FromBits<u16> for u16

const BITS: u32 = 16u32

type Error = Infallible

fn try_from_bits(f: u16) -> Result<Self, Self::Error>

fn into_bits(self) -> u16

impl FromBits<u32> for bool

const BITS: u32 = 1u32

type Error = Infallible

fn try_from_bits(f: u32) -> Result<Self, Self::Error>

fn into_bits(self) -> u32

impl FromBits<u32> for i8

const BITS: u32 = 8u32

type Error = Infallible

fn try_from_bits(f: u32) -> Result<Self, Self::Error>

fn into_bits(self) -> u32

impl FromBits<u32> for i16

const BITS: u32 = 16u32

type Error = Infallible

fn try_from_bits(f: u32) -> Result<Self, Self::Error>

fn into_bits(self) -> u32

impl FromBits<u32> for i32

const BITS: u32 = 32u32

type Error = Infallible

fn try_from_bits(f: u32) -> Result<Self, Self::Error>

fn into_bits(self) -> u32

impl FromBits<u32> for u8

const BITS: u32 = 8u32

type Error = Infallible

fn try_from_bits(f: u32) -> Result<Self, Self::Error>

fn into_bits(self) -> u32

impl FromBits<u32> for u16

const BITS: u32 = 16u32

type Error = Infallible

fn try_from_bits(f: u32) -> Result<Self, Self::Error>

fn into_bits(self) -> u32