Struct Request 

pub struct Request {
    pub items: Vec<Item>,
    pub input_queue: Option<ItemQueue>,
    pub options: Option<RequestOptions>,
}

A unit of work submitted to a Session.

A request carries its input items, an optional streaming input_queue (for incremental input such as live audio), and optional options.

Fields

items: Vec<Item>

The input items, in order.

input_queue: Option<ItemQueue>

An optional streaming input queue. When present, its items are consumed in addition to items.

options: Option<RequestOptions>

Optional per-request options overriding any session options.

Implementations

impl Request

pub fn new() -> Self

An empty request.

pub fn from_items(items: impl Into<Vec<Item>>) -> Self

A request built from a list of input items.

pub fn with_item(self, item: Item) -> Self

Append an input item (builder-style).

pub fn with_input_queue(self, queue: ItemQueue) -> Self

Attach a streaming input queue (builder-style).

pub fn with_options(self, options: RequestOptions) -> Self

Attach per-request options (builder-style).

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the “default value” for a type.