Enum Payload 

pub enum Payload {
    Ready(WebSocketReady),
    Started(WebSocketStarted),
    Audio(Vec<u8>),
    Done(WebSocketDone),
    Cancelled(WebSocketCancelled),
    Error(WebSocketError),
}

Variants

Ready(WebSocketReady)

Sent once per connection when the engine is ready to synthesize (pipelines loaded and serving). Gate start on this event.

Started(WebSocketStarted)

The context was accepted; precedes any of its audio.

Audio(Vec<u8>)

A chunk of encoded audio, in the format requested at start.

Done(WebSocketDone)

Terminal: all audio for the context has been delivered.

Cancelled(WebSocketCancelled)

Terminal: the context was aborted by cancel.

Error(WebSocketError)

Terminal for the context it names. Errors with an empty context_id are connection-scoped and leave open contexts running; the server closes the connection only when the failure is unrecoverable (undecodable frames, failed authentication).

Implementations

impl Payload

pub fn encode(&self, buf: &mut impl BufMut)

Encodes the message to a buffer.

pub fn merge( field: &mut Option<Payload>, tag: u32, wire_type: WireType, buf: &mut impl Buf, ctx: DecodeContext, ) -> Result<(), DecodeError>

Decodes an instance of the message from a buffer, and merges it into self.

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl PartialEq for Payload

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Payload