Struct devela::_docs::examples::bitfield::ExampleBitfieldCustom

pub struct ExampleBitfieldCustom { /* private fields */ }

An example created with bitfield!, with public custom fields but no extra methods.

use devela::data::bitfield;

bitfield! {
    (custom)

    /// An example created with [`bitfield!`],
    /// with public custom fields but no extra methods.
    pub struct ExampleBitfieldCustom(u16) {
        /// Documentation for the first field.
        FLAG1: 0;
        /// Documentation for the second field.
        FLAG2: 1;
        MASK: 0, 1;
    }
}

let mut b = ExampleBitfieldCustom::with_field_mask();
assert![b.is_field_mask()];
assert![b.is_field_flag1()];
assert![b.is_field_flag2()];
let _c = b.unset_field_flag1();

Implementations

impl ExampleBitfieldCustom

pub const FLAG1: Self = _

Documentation for the first field.

pub const FLAG2: Self = _

Documentation for the first field.

pub const MASK0: Self = _

impl ExampleBitfieldCustom

Custom fields operations

pub const fn without_fields() -> Self

Returns a new ExampleBitfieldCustom with none of the fields set.

pub const fn with_all_fields() -> Self

Returns a new ExampleBitfieldCustom with all the fields set.

pub const fn are_all_fields(self) -> bool

Returns true if it all the fields are set.

impl ExampleBitfieldCustom

FLAG1 single field operations

pub const fn with_field_flag1() -> Self

Returns a new ExampleBitfieldCustom with FLAG1 field set.

pub const fn is_field_flag1(self) -> bool

Returns true if the FLAG1 field is set.

pub const fn bits_field_flag1(self) -> u32

Returns the size of the field in bits.

pub const fn get_field_flag1(self) -> Self

Gets a copy of self with only the bits of FLAG1 field.

pub const fn get_field_value_flag1(self) -> Self

Gets the value of the bits of FLAG1 field.

pub const fn set_field_flag1(self) -> Self

Returns a copy of self with the FLAG1 field set.

pub fn mut_set_field_flag1(&mut self)

Sets the FLAG1 field.

pub const fn set_field_value_flag1(self, value: u16) -> Self

Sets the given value into the bits of FLAG1 field.

pub const fn unset_field_flag1(self) -> Self

Returns a copy of self with the FLAG1 field set.

pub fn mut_unset_field_flag1(&mut self)

Unsets the FLAG1 field.

pub const fn flip_field_flag1(self) -> Self

Returns a copy of self with the FLAG1 field flipped.

pub fn mut_flip_field_flag1(&mut self)

Flips the FLAG1 field.

impl ExampleBitfieldCustom

FLAG2 single field operations

pub const fn with_field_flag2() -> Self

Returns a new ExampleBitfieldCustom with FLAG2 field set.

pub const fn is_field_flag2(self) -> bool

Returns true if the FLAG2 field is set.

pub const fn bits_field_flag2(self) -> u32

Returns the size of the field in bits.

pub const fn get_field_flag2(self) -> Self

Gets a copy of self with only the bits of FLAG2 field.

pub const fn get_field_value_flag2(self) -> Self

Gets the value of the bits of FLAG2 field.

pub const fn set_field_flag2(self) -> Self

Returns a copy of self with the FLAG2 field set.

pub fn mut_set_field_flag2(&mut self)

Sets the FLAG2 field.

pub const fn set_field_value_flag2(self, value: u16) -> Self

Sets the given value into the bits of FLAG2 field.

pub const fn unset_field_flag2(self) -> Self

Returns a copy of self with the FLAG2 field set.

pub fn mut_unset_field_flag2(&mut self)

Unsets the FLAG2 field.

pub const fn flip_field_flag2(self) -> Self

Returns a copy of self with the FLAG2 field flipped.

pub fn mut_flip_field_flag2(&mut self)

Flips the FLAG2 field.

impl ExampleBitfieldCustom

MASK0 single field operations

pub const fn with_field_mask0() -> Self

Returns a new ExampleBitfieldCustom with MASK0 field set.

pub const fn is_field_mask0(self) -> bool

Returns true if the MASK0 field is set.

pub const fn bits_field_mask0(self) -> u32

Returns the size of the field in bits.

pub const fn get_field_mask0(self) -> Self

Gets a copy of self with only the bits of MASK0 field.

pub const fn get_field_value_mask0(self) -> Self

Gets the value of the bits of MASK0 field.

pub const fn set_field_mask0(self) -> Self

Returns a copy of self with the MASK0 field set.

pub fn mut_set_field_mask0(&mut self)

Sets the MASK0 field.

pub const fn set_field_value_mask0(self, value: u16) -> Self

Sets the given value into the bits of MASK0 field.

pub const fn unset_field_mask0(self) -> Self

Returns a copy of self with the MASK0 field set.

pub fn mut_unset_field_mask0(&mut self)

Unsets the MASK0 field.

pub const fn flip_field_mask0(self) -> Self

Returns a copy of self with the MASK0 field flipped.

pub fn mut_flip_field_mask0(&mut self)

Flips the MASK0 field.

Trait Implementations

impl Binary for ExampleBitfieldCustom

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

Formats the value using the given formatter.

impl Clone for ExampleBitfieldCustom

fn clone(&self) -> ExampleBitfieldCustom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExampleBitfieldCustom

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

Formats the value using the given formatter.

impl Default for ExampleBitfieldCustom

fn default() -> Self

Returns the “default value” for a type.

impl Display for ExampleBitfieldCustom

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

Formats the value using the given formatter.

impl Hash for ExampleBitfieldCustom

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerExp for ExampleBitfieldCustom

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

Formats the value using the given formatter.

impl LowerHex for ExampleBitfieldCustom

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

Formats the value using the given formatter.

impl Octal for ExampleBitfieldCustom

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

Formats the value using the given formatter.

impl Ord for ExampleBitfieldCustom

fn cmp(&self, other: &ExampleBitfieldCustom) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ExampleBitfieldCustom

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ExampleBitfieldCustom

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

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

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

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

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

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

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

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

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

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

impl UpperExp for ExampleBitfieldCustom

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

Formats the value using the given formatter.

impl UpperHex for ExampleBitfieldCustom

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

Formats the value using the given formatter.

impl Copy for ExampleBitfieldCustom

impl Eq for ExampleBitfieldCustom

impl StructuralPartialEq for ExampleBitfieldCustom