Struct AnalyzerSink 

pub struct AnalyzerSink { /* private fields */ }

Available on crate feature tokio only.

A futures_sink::Sink that ingests Vec<f32> interleaved sample chunks into the wrapped Analyzer.

The sink is permanently in the ready state; send and friends never block waiting for capacity. Errors from Analyzer::push_interleaved surface as Sink::Error.

Implementations

impl AnalyzerSink

pub fn new(analyzer: Analyzer) -> Self

Wrap the analyzer.

pub fn into_inner(self) -> Option<Analyzer>

Recover the inner analyzer, e.g. to call Analyzer::finalize.

Returns None if the sink was already consumed.

pub fn analyzer_mut(&mut self) -> Option<&mut Analyzer>

Borrow the inner analyzer for snapshotting.

Trait Implementations

impl Debug for AnalyzerSink

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

Formats the value using the given formatter.

impl Sink<Vec<f32>> for AnalyzerSink

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Vec<f32>) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.