Struct PeriodCtrl 

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

Period high bits and channel control (NR14 / NR24 / NR34).

Bit	Field	Access	Meaning
7	trigger	W	(Re)start the channel.
6	length_enable	R/W	Stop the channel when the length timer expires.
5-3	—		Unused.
2-0	period_high	W	Upper 3 bits of the 11-bit period (low 8 in NRx3).

Implementations

impl PeriodCtrl

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 period_high(&self) -> u8

Upper 3 bits of the 11-bit period (low 8 bits live in NRx3).

Bits: 0..3

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

Upper 3 bits of the 11-bit period (low 8 bits live in NRx3).

Bits: 0..3

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

Upper 3 bits of the 11-bit period (low 8 bits live in NRx3).

Bits: 0..3

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

Upper 3 bits of the 11-bit period (low 8 bits live in NRx3).

Bits: 0..3

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

Upper 3 bits of the 11-bit period (low 8 bits live in NRx3).

Bits: 0..3

pub const fn length_enable(&self) -> bool

Stop the channel when the length timer expires.

Bits: 6..7

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

Stop the channel when the length timer expires.

Bits: 6..7

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

Stop the channel when the length timer expires.

Bits: 6..7

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

Stop the channel when the length timer expires.

Bits: 6..7

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

Stop the channel when the length timer expires.

Bits: 6..7

pub const fn trigger(&self) -> bool

Trigger (write-only): (re)start the channel.

Bits: 7..8

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

Trigger (write-only): (re)start the channel.

Bits: 7..8

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

Trigger (write-only): (re)start the channel.

Bits: 7..8

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

Trigger (write-only): (re)start the channel.

Bits: 7..8

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

Trigger (write-only): (re)start the channel.

Bits: 7..8

Trait Implementations

impl Clone for PeriodCtrl

fn clone(&self) -> PeriodCtrl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PeriodCtrl

impl Debug for PeriodCtrl

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

Formats the value using the given formatter.

impl Default for PeriodCtrl

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PeriodCtrl

impl From<PeriodCtrl> for u8

fn from(v: PeriodCtrl) -> Self

Converts to this type from the input type.

impl From<u8> for PeriodCtrl

fn from(v: u8) -> Self

Converts to this type from the input type.

impl PartialEq for PeriodCtrl

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PeriodCtrl