Enum SamplingConfig

pub enum SamplingConfig {
    // some variants omitted
}

Available on crate features derive and sampling_config only.

The configuration for sampling.

Implementations

impl SamplingConfig

pub const FREQ_40K: Self

A SamplingConfig of 40kHz.

pub const FREQ_4K: Self

A SamplingConfig of 4kHz.

pub fn new(value: impl Into<SamplingConfig>) -> Self

Creates a new SamplingConfig.

pub fn division(&self) -> Result<u16, SamplingConfigError>

The division number of the sampling frequency.

The sampling frequency is ultrasound_freq / division.

pub fn freq(&self) -> Result<Freq<f32>, SamplingConfigError>

The sampling frequency.

impl SamplingConfig

pub const fn into_nearest(self) -> SamplingConfig

Converts to a SamplingConfig with the nearest frequency or period among the possible values.

Trait Implementations

impl Clone for SamplingConfig

fn clone(&self) -> SamplingConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SamplingConfig

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

Formats the value using the given formatter.

impl From<Freq<f32>> for SamplingConfig

fn from(value: Freq<f32>) -> Self

Converts to this type from the input type.

impl From<NonZero<u16>> for SamplingConfig

fn from(value: NonZeroU16) -> Self

Converts to this type from the input type.

impl PartialEq for SamplingConfig

fn eq(&self, other: &SamplingConfig) -> 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 SamplingConfig

impl StructuralPartialEq for SamplingConfig