Struct symphonia_core::probe::Hint

pub struct Hint { /* private fields */ }

A Hint provides additional information and context when probing a media source stream.

For example, the Probe cannot examine the extension or mime-type of the media because MediaSourceStream abstracts away such details. However, the embedder may have this information from a file path, HTTP header, email attachment metadata, etc. Hints are optional, and won’t lead the probe astray if they’re wrong, but they may provide an informed initial guess and optimize the guessing process siginificantly especially as more formats are registered.

Implementations

impl Hint

pub fn new() -> Self

Instantiate an empty Hint.

pub fn with_extension(&mut self, extension: &str) -> &mut Self

Add a file extension Hint.

pub fn mime_type(&mut self, mime_type: &str) -> &mut Self

Add a MIME/Media-type Hint.

Trait Implementations

impl Clone for Hint

fn clone(&self) -> Hint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hint

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

Formats the value using the given formatter.

impl Default for Hint

fn default() -> Hint

Returns the “default value” for a type.