Skip to content

Source snapshot · 12 October 2026

API reference / ravet_embedded_gain::Gain

ravet_embedded_gain

Struct Gain

pub struct Gain { /* private fields */ }

Expand description

C-layout reference state, exclusively owned by the callback/firmware. Treat fields as opaque in C; initialize through the reference ABI.

Implementations§

impl Gain

pub const fn new() -> Self

pub fn gain(&self) -> f32

pub fn set_gain(&mut self, gain: f32) -> bool

Reject nonfinite/out-of-range amplitudes without mutation.

Trait Implementations§

impl Clone for Gain

fn clone(&self) -> Gain

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · §

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

Performs copy-assignment from source. Read more

impl Copy for Gain

impl Debug for Gain

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

Formats the value using the given formatter. Read more

impl Default for Gain

fn default() -> Self

Returns the “default value” for a type. Read more

impl Processor for Gain

fn prepare(&mut self, config: ProcessConfig) -> Result<(), PrepareError>

fn process(&mut self, block: &mut ProcessBlock<'_, '_, '_>) -> ProcessStatus

fn reset(&mut self)

fn deactivate(&mut self)

fn start_audio(&mut self) -> Result<(), ProcessError>

Optional explicit audio-owner session start, after prepare and before rendering. Default is a no-op. Consumers using these hooks call once on the audio owner and stop there before transfer/deactivation. Failure must leave this processor stopped; earlier successful nodes may be stopped. Hooks follow prepared callback allocation/locking/I/O obligations. Existing adapters do not implicitly opt in; explicit graph sessions supply them.

fn stop_audio(&mut self)

End an explicitly started session on its audio owner, without deactivation or storage destruction. Default no-op; preparation/history may be retained.

fn try_reset(&mut self) -> Result<(), ProcessError>

Attempt history reset without allocating or changing configuration. Existing processors delegate to their successful legacy reset by default. A refusal may follow earlier reset work; consumers must remain faulted.

fn latency_samples(&self) -> u32

Prepared algorithmic latency in samples. Changes are advertised by adapters using their format’s restart/latency protocol outside the audio callback.

fn tail(&self) -> Tail

Decay policy after input stops. Adapters must map this to the host protocol.

Auto Trait Implementations§

impl Freeze for Gain

impl RefUnwindSafe for Gain

impl Send for Gain

impl Sync for Gain

impl Unpin for Gain

impl UnsafeUnpin for Gain

impl UnwindSafe for Gain

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.