ssip_client::client

Enum Request

pub enum Request {
Show 51 variants
    SetName(ClientName),
    Speak,
    SendLine(String),
    SendLines(Vec<String>),
    SpeakChar(char),
    SpeakKey(KeyName),
    Stop(MessageScope),
    Cancel(MessageScope),
    Pause(MessageScope),
    Resume(MessageScope),
    SetPriority(Priority),
    SetDebug(bool),
    SetOutputModule(ClientScope, String),
    GetOutputModule,
    ListOutputModules,
    SetLanguage(ClientScope, String),
    GetLanguage,
    SetSsmlMode(bool),
    SetPunctuationMode(ClientScope, PunctuationMode),
    SetSpelling(ClientScope, bool),
    SetCapitalLettersRecognitionMode(ClientScope, CapitalLettersRecognitionMode),
    SetVoiceType(ClientScope, String),
    GetVoiceType,
    ListVoiceTypes,
    SetSynthesisVoice(ClientScope, String),
    ListSynthesisVoices,
    SetRate(ClientScope, i8),
    GetRate,
    SetPitch(ClientScope, i8),
    GetPitch,
    SetVolume(ClientScope, i8),
    GetVolume,
    SetPauseContext(ClientScope, u32),
    SetNotification(NotificationType, bool),
    Begin,
    End,
    SetHistory(ClientScope, bool),
    HistoryGetClients,
    HistoryGetClientId,
    HistoryGetClientMsgs(ClientScope, u32, u32),
    HistoryGetLastMsgId,
    HistoryGetMsg(MessageId),
    HistoryCursorGet,
    HistoryCursorSet(ClientScope, HistoryPosition),
    HistoryCursorMove(CursorDirection),
    HistorySpeak(MessageId),
    HistorySort(SortDirection, SortKey),
    HistorySetShortMsgLength(u32),
    HistorySetMsgTypeOrdering(Vec<Ordering>),
    HistorySearch(ClientScope, String),
    Quit,
}

Expand description

Request for SSIP server.

Variants§

SetName(ClientName)

Speak

SendLine(String)

SendLines(Vec<String>)

SpeakChar(char)

SpeakKey(KeyName)

Stop(MessageScope)

Cancel(MessageScope)

Pause(MessageScope)

Resume(MessageScope)

SetPriority(Priority)

SetDebug(bool)

SetOutputModule(ClientScope, String)

GetOutputModule

ListOutputModules

SetLanguage(ClientScope, String)

GetLanguage

SetSsmlMode(bool)

SetPunctuationMode(ClientScope, PunctuationMode)

SetSpelling(ClientScope, bool)

SetCapitalLettersRecognitionMode(ClientScope, CapitalLettersRecognitionMode)

SetVoiceType(ClientScope, String)

GetVoiceType

ListVoiceTypes

SetSynthesisVoice(ClientScope, String)

ListSynthesisVoices

SetRate(ClientScope, i8)

GetRate

SetPitch(ClientScope, i8)

GetPitch

SetVolume(ClientScope, i8)

GetVolume

SetPauseContext(ClientScope, u32)

SetNotification(NotificationType, bool)

Begin

End

SetHistory(ClientScope, bool)

HistoryGetClients

HistoryGetClientId

HistoryGetClientMsgs(ClientScope, u32, u32)

HistoryGetLastMsgId

HistoryGetMsg(MessageId)

HistoryCursorGet

HistoryCursorSet(ClientScope, HistoryPosition)

HistoryCursorMove(CursorDirection)

HistorySpeak(MessageId)

HistorySort(SortDirection, SortKey)

HistorySetShortMsgLength(u32)

HistorySetMsgTypeOrdering(Vec<Ordering>)

HistorySearch(ClientScope, String)

Quit

Implementations§

impl Request

pub fn is_data(&self) -> bool

Return true if the request are data.

After a Speak has been sent, when the client receives OK_RECEIVING_DATA, the next request must be Request::SendLine or Request::SendLines.

Trait Implementations§

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Request

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for Request

impl RefUnwindSafe for Request

impl Send for Request

impl Sync for Request

impl Unpin for Request

impl UnwindSafe for Request

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)

🔬This is a nightly-only experimental API. (clone_to_uninit)

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.