Struct ExampleField 

pub struct ExampleField(/* private fields */);

Optional docstring for my example bit field.

Implementations

impl ExampleField

Constant values describing ExampleField.

pub const BITS: usize = 8

Number of bits in an instance of ExampleField.

pub const BYTES: usize

Number of bytes used by an instance of ExampleField.

pub const MAX: u8 = u8::MAX

Maximum valid integer for ExampleField.

impl ExampleField

Constructors for creating instances of ExampleField.

pub fn new(value: u8) -> Self

Create a new instance of ExampleField from a u8 value.

pub fn zeros() -> Self

Create a new instance of ExampleField from 0.

pub fn ones() -> Self

Create a new instance of ExampleField from the maximum possible integer value.

pub fn from_binary_str(value: &str) -> Self

Create a new instance of ExampleField from a binary string.

pub fn from_binary_string(value: String) -> Self

Create a new instance of ExampleField from a binary string.

impl ExampleField

Current state of this bitfield.

pub fn as_integer(&self) -> u8

Returns the current field value as a u8

pub fn as_binary(&self) -> String

Returns the current field value as a binary formatted string.

impl ExampleField

Field accessors by index for ExampleField.

pub fn get_index(&self, index: u8) -> bool

Returns the value of the bit at the supplied index as a boolean.

pub fn set_index(&mut self, index: u8)

Sets the value of the bit at the supplied index to 1.

pub fn clear_index(&mut self, index: u8)

Sets the value of the bit at the supplied index to 0.

pub fn toggle_index(&mut self, index: u8)

Flips the value of the bit at the supplied index.

impl ExampleField

Named field accessors by ExampleFlags for ExampleField.

pub fn get(&self, flag: ExampleFlags) -> bool

Returns the value of the bit at the supplied flag as a boolean.

pub fn set(&mut self, flag: ExampleFlags) -> &mut Self

Sets the value of the bit at the supplied flag to 1.

pub fn clear(&mut self, flag: ExampleFlags) -> &mut Self

Sets the value of the bit at the supplied flag to 0.

pub fn toggle(&mut self, flag: ExampleFlags) -> &mut Self

Flips the value of the bit at the supplied flag.

impl ExampleField

Combinators for ExampleField.

pub fn diff(&self, other: Self) -> Self

Returns a new ExampleFieldwith ones for flags that do not match. Does not consume self.

pub fn combine(&self, other: Self) -> Self

Returns a new ExampleFieldwith ones for flags that were set on either input. Does not consume self.

pub fn intersect(&self, other: Self) -> Self

Returns a new ExampleFieldwith ones for flags that were set on both inputs. Does not consume self.

impl ExampleField

Conversion methods.

pub fn into_diff(self, other: Self) -> Self

Returns a new ExampleFieldwith ones for flags that do not match. Consumes self.

pub fn into_combined(self, other: Self) -> Self

Returns a new ExampleFieldwith ones for flags that were set on either input. Consumes self.

pub fn into_intersection(self, other: Self) -> Self

Returns a new ExampleFieldwith ones for flags that were set on both inputs. Consumes self.

Trait Implementations

impl Binary for ExampleField

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

Formats the value using the given formatter.

impl BitAnd for ExampleField

type Output = ExampleField

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAnd<ExampleFlags> for ExampleField

type Output = ExampleField

The resulting type after applying the & operator.

fn bitand(self, rhs: ExampleFlags) -> Self::Output

Performs the & operation.

impl BitAnd<ExampleFlags> for &ExampleField

type Output = ExampleField

The resulting type after applying the & operator.

fn bitand(self, rhs: ExampleFlags) -> Self::Output

Performs the & operation.

impl BitAnd<ExampleFlags> for &mut ExampleField

type Output = ExampleField

The resulting type after applying the & operator.

fn bitand(self, rhs: ExampleFlags) -> Self::Output

Performs the & operation.

impl BitAndAssign for ExampleField

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitAndAssign<ExampleFlags> for ExampleField

fn bitand_assign(&mut self, rhs: ExampleFlags)

Performs the &= operation.

impl BitOr for ExampleField

type Output = ExampleField

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOr<ExampleFlags> for ExampleField

type Output = ExampleField

The resulting type after applying the | operator.

fn bitor(self, rhs: ExampleFlags) -> Self::Output

Performs the | operation.

impl BitOr<ExampleFlags> for &ExampleField

type Output = ExampleField

The resulting type after applying the | operator.

fn bitor(self, rhs: ExampleFlags) -> Self::Output

Performs the | operation.

impl BitOr<ExampleFlags> for &mut ExampleField

type Output = ExampleField

The resulting type after applying the | operator.

fn bitor(self, rhs: ExampleFlags) -> Self::Output

Performs the | operation.

impl BitOrAssign for ExampleField

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitOrAssign<ExampleFlags> for ExampleField

fn bitor_assign(&mut self, rhs: ExampleFlags)

Performs the |= operation.

impl BitXor for ExampleField

type Output = ExampleField

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXor<ExampleFlags> for ExampleField

type Output = ExampleField

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: ExampleFlags) -> Self::Output

Performs the ^ operation.

impl BitXor<ExampleFlags> for &ExampleField

type Output = ExampleField

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: ExampleFlags) -> Self::Output

Performs the ^ operation.

impl BitXor<ExampleFlags> for &mut ExampleField

type Output = ExampleField

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: ExampleFlags) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for ExampleField

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl BitXorAssign<ExampleFlags> for ExampleField

fn bitxor_assign(&mut self, rhs: ExampleFlags)

Performs the ^= operation.

impl Clone for ExampleField

fn clone(&self) -> ExampleField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ExampleField

impl Debug for ExampleField

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

Formats the value using the given formatter.

impl Default for ExampleField

fn default() -> Self

Returns the “default value” for a type.

impl From<ExampleFlags> for ExampleField

Returns a field instance from a flag.

fn from(value: ExampleFlags) -> ExampleField

Converts to this type from the input type.

impl From<u8> for ExampleField

Returns a field instance from value of its underlying type.

fn from(value: u8) -> ExampleField

Converts to this type from the input type.

impl PartialEq for ExampleField

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ExampleField

fn partial_cmp(&self, other: &ExampleField) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ExampleField