Skip to main content

EngineHandle

Struct EngineHandle 

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

Implementations§

Source§

impl EngineHandle

Source

pub fn spawn( cfg: Config, synth: Box<dyn Synthesizer>, sink: Box<dyn AudioSink>, ) -> EngineHandle

Source

pub fn send(&self, cmd: Command)

Fire and forget. A dead engine thread silently drops the command — the daemon notices through the snapshot, not here.

Source

pub fn submit(&self, text: String, opts: SayOpts) -> Result<Option<u64>, String>

Submit text and wait for the engine’s answer.

Source

pub fn snapshot(&self) -> Snapshot

The most recently published snapshot.

Source

pub fn replace_sink(&self, sink: Box<dyn AudioSink>)

Hand the engine a fresh audio device after a failure. Fire and forget, like send: the daemon learns the outcome through the next published snapshot.

Source

pub fn has_shut_down(&self) -> bool

Whether the engine thread has exited, for any reason: shutdown was called, a Command::Shutdown arrived over the channel (e.g. from a D-Bus Quit call), or the thread panicked. Lets the daemon’s main loop notice a dead engine without having to poll shutdown itself.

Source

pub fn shutdown(&self)

Ask the engine thread to stop, and wait for it. Safe to call more than once, including concurrently from two clones: only the first caller to take the JoinHandle actually joins it, and every other caller’s Shutdown send is a harmless no-op once the thread has already exited (the channel is simply dropped along with it).

Trait Implementations§

Source§

impl Clone for EngineHandle

Source§

fn clone(&self) -> EngineHandle

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

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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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