Struct ubits::examples::full_example::ExampleField

source · [−]

pub struct ExampleField(_);

Expand description

Optional docstring for my example bit field.

Implementations

source

impl ExampleField

Constant values describing ExampleField.

source

pub const BITS: usize

Number of bits in an instance of ExampleField.

source

pub const BYTES: usize

Number of bytes used by an instance of ExampleField.

source

pub const MAX: u8

Maximum valid integer for ExampleField.

source

impl ExampleField

Constructors for creating instances of ExampleField.

source

pub fn new(value: u8) -> Self

Create a new instance of ExampleField from a u8 value.

source

pub fn zeros() -> Self

Create a new instance of ExampleField from 0.

source

pub fn ones() -> Self

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

source

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

Create a new instance of ExampleField from a binary string.

source

pub fn from_binary_string(value: String) -> Self

Create a new instance of ExampleField from a binary string.

source

impl ExampleField

Current state of this bitfield.

source

pub fn as_integer(&self) -> u8

Returns the current field value as a u8

source

pub fn as_binary(&self) -> String

Returns the current field value as a binary formatted string.

source

impl ExampleField

Field accessors by index for ExampleField.

source

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

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

source

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

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

source

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

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

source

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

Flips the value of the bit at the supplied index.

source

impl ExampleField

Named field accessors by ExampleFlags for ExampleField.

source

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

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

source

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

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

source

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

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

source

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

Flips the value of the bit at the supplied flag.

source

impl ExampleField

Combinators for ExampleField.

source

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

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

source

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

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

source

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

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

source

impl ExampleField

Conversion methods.

source

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

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

source

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

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

source

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

source

impl Binary for ExampleField

source

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

Formats the value using the given formatter.

source

impl BitAnd<ExampleField> for ExampleField

type Output = Self

The resulting type after applying the & operator.

source

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

Performs the & operation. Read more

source

impl BitAnd<ExampleFlags> for ExampleField

type Output = ExampleField

The resulting type after applying the & operator.

source

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

Performs the & operation. Read more

source

impl BitAnd<ExampleFlags> for &ExampleField

type Output = ExampleField

The resulting type after applying the & operator.

source

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

Performs the & operation. Read more

source

impl BitAnd<ExampleFlags> for &mut ExampleField

type Output = ExampleField

The resulting type after applying the & operator.

source

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

Performs the & operation. Read more

source

impl BitAndAssign<ExampleField> for ExampleField

source

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation. Read more

source

impl BitAndAssign<ExampleFlags> for ExampleField

source

fn bitand_assign(&mut self, rhs: ExampleFlags)

Performs the &= operation. Read more

source

impl BitOr<ExampleField> for ExampleField

type Output = Self

The resulting type after applying the | operator.

source

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

Performs the | operation. Read more

source

impl BitOr<ExampleFlags> for ExampleField

type Output = ExampleField

The resulting type after applying the | operator.

source

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

Performs the | operation. Read more

source

impl BitOr<ExampleFlags> for &ExampleField

type Output = ExampleField

The resulting type after applying the | operator.

source

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

Performs the | operation. Read more

source

impl BitOr<ExampleFlags> for &mut ExampleField

type Output = ExampleField

The resulting type after applying the | operator.

source

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

Performs the | operation. Read more

source

impl BitOrAssign<ExampleField> for ExampleField

source

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation. Read more

source

impl BitOrAssign<ExampleFlags> for ExampleField

source

fn bitor_assign(&mut self, rhs: ExampleFlags)

Performs the |= operation. Read more

source

impl BitXor<ExampleField> for ExampleField

type Output = Self

The resulting type after applying the ^ operator.

source

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

Performs the ^ operation. Read more

source

impl BitXor<ExampleFlags> for ExampleField

type Output = ExampleField

The resulting type after applying the ^ operator.

source

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

Performs the ^ operation. Read more

source

impl BitXor<ExampleFlags> for &ExampleField

type Output = ExampleField

The resulting type after applying the ^ operator.

source

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

Performs the ^ operation. Read more

source

impl BitXor<ExampleFlags> for &mut ExampleField

type Output = ExampleField

The resulting type after applying the ^ operator.

source

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

Performs the ^ operation. Read more

source

impl BitXorAssign<ExampleField> for ExampleField

source

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation. Read more

source

impl BitXorAssign<ExampleFlags> for ExampleField

source

fn bitxor_assign(&mut self, rhs: ExampleFlags)

Performs the ^= operation. Read more

source

impl Clone for ExampleField

source

fn clone(&self) -> ExampleField

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for ExampleField

source

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

Formats the value using the given formatter. Read more

source

impl Default for ExampleField

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl From<ExampleFlags> for ExampleField

Returns a field instance from a flag.

source

fn from(value: ExampleFlags) -> ExampleField

Performs the conversion.

source

impl From<u8> for ExampleField

Returns a field instance from value of its underlying type.

source

fn from(value: u8) -> ExampleField

Performs the conversion.

source

impl PartialEq<ExampleField> for ExampleField

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

impl PartialOrd<ExampleField> for ExampleField

source

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

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

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl Copy for ExampleField

source

impl StructuralPartialEq for ExampleField

Auto Trait Implementations

impl RefUnwindSafe for ExampleField

impl Send for ExampleField

impl Sync for ExampleField

impl Unpin for ExampleField

impl UnwindSafe for ExampleField

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.