Skip to main content

PartialSession

Struct PartialSession 

Source
pub struct PartialSession { /* private fields */ }
Expand description

Host-driven partial STT session state.

Typical loop:

  1. push mic chunks
  2. if should_decode_partial, host runs STT on partial_window_samples()
  3. call on_decode_result with the transcript text
  4. on release, finalize with a definitive full-window decode

Implementations§

Source§

impl PartialSession

Source

pub fn new(config: PartialSessionConfig) -> Self

Source

pub fn dictation() -> Self

Dictation-oriented defaults.

Source

pub fn config(&self) -> &PartialSessionConfig

Source

pub fn buffer(&self) -> &PcmBuffer

Source

pub fn buffer_mut(&mut self) -> &mut PcmBuffer

Source

pub fn stable_text(&self) -> &str

Source

pub fn is_closed(&self) -> bool

Source

pub fn push(&mut self, chunk: &[f32]) -> Result<()>

Push mono 16 kHz samples into the ring buffer.

Source

pub fn should_decode_partial(&self) -> bool

Whether the host should start a partial decode now.

Source

pub fn partial_window_samples(&self) -> ContiguousOwned

Contiguous PCM for the current partial window (host passes to STT).

Source

pub fn begin_partial(&mut self) -> Option<CancelFlag>

Begin a partial: marks the clock, increments inflight, returns cancel token.

Supersedes any previous inflight cancel token (cooperative cancel).

Source

pub fn on_decode_result( &mut self, raw_text: &str, latency_ms: Option<u64>, ) -> PartialUpdate

Host delivers a partial decode result (or error → call Self::end_partial).

Source

pub fn end_partial(&mut self)

Mark a partial as finished without a text update (cancel/error).

Source

pub fn finalize( &mut self, final_text: &str, latency_ms: Option<u64>, ) -> PartialUpdate

Final decode path: host supplies definitive transcript for the full buffer.

Source

pub fn cancel(&mut self) -> PartialUpdate

Cancel the session and any in-flight partial.

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> 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> 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, 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