Struct Sweep 

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

Channel 1 frequency sweep (NR10).

Bit	Field	Access	Meaning
7	—		Unused.
6-4	pace	R/W	An iteration every pace 128 Hz ticks; 0 disables the sweep.
3	subtract	R/W	Period direction: clear adds, set subtracts.
2-0	step	R/W	Shift applied to the period each iteration.

Implementations

impl Sweep

pub const fn new() -> Self

Creates a new default initialized bitfield.

pub const fn from_bits(bits: u8) -> Self

Convert from bits.

pub const fn into_bits(self) -> u8

Convert into bits.

pub const fn step(&self) -> u8

Step: shift applied to the period each iteration.

Bits: 0..3

pub const fn with_step_checked(self, value: u8) -> Result<Self, ()>

Step: shift applied to the period each iteration.

Bits: 0..3

pub const fn with_step(self, value: u8) -> Self

Step: shift applied to the period each iteration.

Bits: 0..3

pub const fn set_step(&mut self, value: u8)

Step: shift applied to the period each iteration.

Bits: 0..3

pub const fn set_step_checked(&mut self, value: u8) -> Result<(), ()>

Step: shift applied to the period each iteration.

Bits: 0..3

pub const fn subtract(&self) -> bool

Direction: false adds to the period, true subtracts.

Bits: 3..4

pub const fn with_subtract_checked(self, value: bool) -> Result<Self, ()>

Direction: false adds to the period, true subtracts.

Bits: 3..4

pub const fn with_subtract(self, value: bool) -> Self

Direction: false adds to the period, true subtracts.

Bits: 3..4

pub const fn set_subtract(&mut self, value: bool)

Direction: false adds to the period, true subtracts.

Bits: 3..4

pub const fn set_subtract_checked(&mut self, value: bool) -> Result<(), ()>

Direction: false adds to the period, true subtracts.

Bits: 3..4

pub const fn pace(&self) -> u8

Pace: an iteration every pace 128 Hz ticks (0 disables sweep).

Bits: 4..7

pub const fn with_pace_checked(self, value: u8) -> Result<Self, ()>

Pace: an iteration every pace 128 Hz ticks (0 disables sweep).

Bits: 4..7

pub const fn with_pace(self, value: u8) -> Self

Pace: an iteration every pace 128 Hz ticks (0 disables sweep).

Bits: 4..7

pub const fn set_pace(&mut self, value: u8)

Pace: an iteration every pace 128 Hz ticks (0 disables sweep).

Bits: 4..7

pub const fn set_pace_checked(&mut self, value: u8) -> Result<(), ()>

Pace: an iteration every pace 128 Hz ticks (0 disables sweep).

Bits: 4..7

Trait Implementations

impl Clone for Sweep

fn clone(&self) -> Sweep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Sweep

impl Debug for Sweep

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

Formats the value using the given formatter.

impl Default for Sweep

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Sweep

impl From<Sweep> for u8

fn from(v: Sweep) -> Self

Converts to this type from the input type.

impl From<u8> for Sweep

fn from(v: u8) -> Self

Converts to this type from the input type.

impl PartialEq for Sweep

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Sweep