Struct ChannelConfig 

#[non_exhaustive]
pub struct ChannelConfig { /* private fields */ }

Sigma-delta channel configuration.

The hardware stores the prescaler and pulse density in the same register, so applying a complete channel configuration can update both fields with a single register write.

Implementations

impl ChannelConfig

pub fn with_pulse_density(self, pulse_density: i8) -> Self

Assign the given value to the pulse_density field.

pub fn pulse_density(&self) -> i8

Pulse density in the hardware range -128..=127.

impl ChannelConfig

pub const fn new() -> Self

Creates a new channel configuration with the default prescaler and pulse density.

pub fn with_frequency(self, frequency: Rate) -> Result<Self, Error>

Sets the requested output frequency.

Selects the prescaler that produces the closest output frequency using the currently configured SDM clock source.

Errors

Returns Error::UnreachableTargetFrequency when no hardware prescaler can represent the requested frequency.

pub fn with_prescaler(self, prescaler: u16) -> Result<Self, Error>

Sets the hardware prescaler.

The hardware divider range is 1..=256.

Errors

Returns Error::PrescalerOutOfRange when prescaler is not in 1..=256.

pub const fn with_duty(self, duty: u8) -> Self

Sets duty cycle. 0 maps to the minimum density and 255 maps to the maximum density.

Trait Implementations

impl Clone for ChannelConfig

Available on crate feature unstable only.

fn clone(&self) -> ChannelConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelConfig

Available on crate feature unstable only.

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

Formats the value using the given formatter.

impl Default for ChannelConfig

Available on crate feature unstable only.

fn default() -> ChannelConfig

Returns the “default value” for a type.

impl PartialEq for ChannelConfig

Available on crate feature unstable only.

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ChannelConfig

Available on crate feature unstable only.

impl Eq for ChannelConfig

Available on crate feature unstable only.

impl StructuralPartialEq for ChannelConfig

Available on crate feature unstable only.