Skip to main content

Engine

Struct Engine 

Source
pub struct Engine { /* private fields */ }

Implementations§

Source§

impl Engine

Source

pub fn prepare( config: EngineConfig, options: EngineOptions, ) -> Result<Self, AsrError>

Source

pub fn config(&self) -> &EngineConfig

Source

pub fn capabilities(&self) -> &BackendCapabilities

Source

pub fn start(&self, options: SessionOptions) -> Result<Session, AsrError>

Source

pub fn transcribe( &self, audio: &AudioBuffer, options: SessionOptions, deadline: Instant, ) -> SessionResult

Source

pub fn transcribe_streaming( &self, audio: &AudioBuffer, options: SessionOptions, deadline: Instant, progress: TranscriptSnapshotSink, ) -> SessionResult

Transcribe::transcribe_streaming over the whole-recording one-shot face: the same session pipeline as Engine::transcribe, plus a TranscriptSnapshotSink that receives each updated snapshot of the emerging transcript while the session runs. A snapshot is the full text so far (committed segments plus the pending partials), not a delta — callers overwrite, never append.

For an engine that produces no incremental updates (the offline families), the sink simply never fires and the call degenerates to Engine::transcribe with one extra subscription.

The sink fires from a helper thread; it should be cheap (hand the text off and return) or it delays the session. When the sink reports the consumer is gone, the session is cancelled and the call returns early with a Cancelled failure.

Trait Implementations§

Source§

impl Clone for Engine

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Engine

Source§

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

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

impl Transcribe for Engine

Source§

fn transcribe( &self, buffer: &AudioBuffer, options: SessionOptions, deadline: Instant, ) -> SessionResult

Source§

fn supports_streaming(&self) -> bool

Whether Transcribe::transcribe_streaming carries progress for this engine. The handler refuses stream=true with a 400 up front when this is false — a wrapper that does not override the streaming face keeps the pre-streaming contract instead of a stream that never carries progress. Override both methods together (or neither).
Source§

fn transcribe_streaming( &self, buffer: &AudioBuffer, options: SessionOptions, deadline: Instant, progress: TranscriptSnapshotSink, ) -> SessionResult

The streaming face stream=true requests transcribe through: same one-shot upload, plus a sink receiving the full emerging transcript each time it changes (a snapshot to overwrite, not a delta — see TranscriptSnapshotSink). The default implementation refuses, so an engine that reports Transcribe::supports_streaming but does not override this still fails the request instead of stalling.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Engine

§

impl !UnwindSafe for Engine

§

impl Forget for Engine

§

impl Freeze for Engine

§

impl Move for Engine

§

impl Send for Engine

§

impl Sync for Engine

§

impl Unpin for Engine

§

impl UnsafeUnpin for Engine

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, dest: *mut u8)

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

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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