Enum ResourceInput 

#[non_exhaustive]
pub enum ResourceInput<'a> {
    Text {
        title: Option<&'a str>,
        text: &'a str,
    },
    Image {
        bytes: &'a [u8],
    },
    Audio {
        samples: &'a [f32],
        sample_rate: u32,
    },
    Video {
        frames: &'a [VideoFrame<'a>],
    },
}

A borrowed input to embed. The request selects its task independently.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text

A text segment. title is a heading or file name, when one is known.

Fields

title: Option<&'a str>

text: &'a str

Image

An encoded image file (PNG, JPEG, …).

Fields

bytes: &'a [u8]

Audio

Mono PCM samples at the given sample rate.

Fields

samples: &'a [f32]

sample_rate: u32

Video

Decoded frames with their timestamps. Reserved: no shipped embedder accepts video yet.

Fields

frames: &'a [VideoFrame<'a>]

Implementations

impl ResourceInput<'_>

pub fn modality(&self) -> Modality

Trait Implementations

impl<'a> Clone for ResourceInput<'a>

fn clone(&self) -> ResourceInput<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ResourceInput<'a>

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

Formats the value using the given formatter.