Struct ether_dream::dac::PointControl

pub struct PointControl { /* fields omitted */ }

The set of flags used to represent the control field of a DacPoint.

Methods

impl PointControl

pub const CHANGE_RATE: PointControl

Indicates to the DAC to read a new point rate out of the point rate buffer and set it as the current playback rate.

If the buffer is empty, the rate is not changed.

pub const fn empty() -> PointControl

Returns an empty set of flags

pub const fn all() -> PointControl

Returns the set containing all flags.

pub const fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u16) -> Option<PointControl>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u16) -> PointControl

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u16) -> PointControl

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: PointControl) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: PointControl) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: PointControl)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: PointControl)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: PointControl)

Toggles the specified flags in-place.

pub fn set(&mut self, other: PointControl, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for PointControl

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

Formats the value using the given formatter.

impl BitAnd<PointControl> for PointControl

type Output = PointControl

The resulting type after applying the & operator.

fn bitand(self, other: PointControl) -> PointControl

Returns the intersection between the two sets of flags.

impl BitAndAssign<PointControl> for PointControl

fn bitand_assign(&mut self, other: PointControl)

Disables all flags disabled in the set.

impl BitOr<PointControl> for PointControl

type Output = PointControl

The resulting type after applying the | operator.

fn bitor(self, other: PointControl) -> PointControl

Returns the union of the two sets of flags.

impl BitOrAssign<PointControl> for PointControl

fn bitor_assign(&mut self, other: PointControl)

Adds the set of flags.

impl BitXor<PointControl> for PointControl

type Output = PointControl

The resulting type after applying the ^ operator.

fn bitxor(self, other: PointControl) -> PointControl

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<PointControl> for PointControl

fn bitxor_assign(&mut self, other: PointControl)

Toggles the set of flags.

impl Clone for PointControl

fn clone(&self) -> PointControl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PointControl

impl Debug for PointControl

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

Formats the value using the given formatter.

impl Eq for PointControl

impl Extend<PointControl> for PointControl

fn extend<T: IntoIterator<Item = PointControl>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<PointControl> for PointControl

fn from_iter<T: IntoIterator<Item = PointControl>>(iterator: T) -> PointControl

Creates a value from an iterator.

impl Hash for PointControl

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for PointControl

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

Formats the value using the given formatter.

impl Not for PointControl

type Output = PointControl

The resulting type after applying the ! operator.

fn not(self) -> PointControl

Returns the complement of this set of flags.

impl Octal for PointControl

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

Formats the value using the given formatter.

impl Ord for PointControl

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<PointControl> for PointControl

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

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

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

This method tests for !=.

impl PartialOrd<PointControl> for PointControl

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for PointControl

impl StructuralPartialEq for PointControl

impl Sub<PointControl> for PointControl

type Output = PointControl

The resulting type after applying the - operator.

fn sub(self, other: PointControl) -> PointControl

Returns the set difference of the two sets of flags.

impl SubAssign<PointControl> for PointControl

fn sub_assign(&mut self, other: PointControl)

Disables all flags enabled in the set.

impl UpperHex for PointControl

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

Formats the value using the given formatter.