autd3_driver::firmware::fpga

Struct SamplingConfig

Source 
#[repr(C)]
pub struct SamplingConfig { /* private fields */ }
Expand description

The configuration for sampling.

Implementations§

Source§

impl SamplingConfig

Source

pub const fn division(&self) -> u16

The division number of the sampling frequency.

The sampling frequency is ULTRASOUND_FREQ / division.

Source§

impl SamplingConfig

Source

pub const FREQ_40K: SamplingConfig

A SamplingConfig of 40kHz.

Source

pub const FREQ_4K: SamplingConfig

A SamplingConfig of 4kHz.

Source

pub const FREQ_MIN: SamplingConfig

A SamplingConfig of the minimum frequency.

Source

pub fn new(value: impl IntoSamplingConfig) -> Result<Self, AUTDDriverError>

Creates a new SamplingConfig.

Source

pub fn new_nearest(value: impl IntoSamplingConfigNearest) -> Self

Creates a new SamplingConfig with the nearest frequency or period value of the possible values.

Source

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

Gets the sampling frequency.

Source

pub fn period(&self) -> Duration

Gets the sampling period.

Trait Implementations§

Source§

impl Clone for SamplingConfig

Source§

fn clone(&self) -> SamplingConfig

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SamplingConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<SamplingConfig> for STMConfig

Source§

fn from(config: SamplingConfig) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for SamplingConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl TryFrom<(STMConfig, usize)> for SamplingConfig

Source§

type Error = AUTDDriverError

The type returned in the event of a conversion error.
Source§

fn try_from(value: (STMConfig, usize)) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<(STMConfigNearest, usize)> for SamplingConfig

Source§

type Error = AUTDDriverError

The type returned in the event of a conversion error.
Source§

fn try_from(value: (STMConfigNearest, usize)) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryInto<SamplingConfig> for Duration

Source§

type Error = AUTDDriverError

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<SamplingConfig, Self::Error>

Performs the conversion.
Source§

impl TryInto<SamplingConfig> for Freq<f32>

Source§

type Error = AUTDDriverError

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<SamplingConfig, Self::Error>

Performs the conversion.
Source§

impl TryInto<SamplingConfig> for Freq<u32>

Source§

type Error = AUTDDriverError

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<SamplingConfig, Self::Error>

Performs the conversion.
Source§

impl Copy for SamplingConfig

Source§

impl StructuralPartialEq for SamplingConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,