Enum AudioSource 

#[non_exhaustive]
pub enum AudioSource {
    Read(PathBuf),
    Download(Uri, Option<Txt>),
    Data(AudioHash, IpcBytes, AudioDataFormat),
    Audio(AudioVar),
}

The different sources of an audio resource.

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.

Read(PathBuf)

A path to an audio file in the file system.

Audio equality is defined by the path, a copy of the audio in another path is a different audio.

Download(Uri, Option<Txt>)

A uri to an audio resource downloaded using HTTP GET with an optional HTTP ACCEPT string.

If the ACCEPT line is not given, all audio formats supported by the view-process backend are accepted.

Audio equality is defined by the URI and ACCEPT string.

Data(AudioHash, IpcBytes, AudioDataFormat)

Shared reference to bytes for an encoded or decoded audio.

Audio equality is defined by the hash, it is usually the hash of the bytes but it does not need to be.

Inside AUDIOS the reference to the bytes is held only until the audio finishes decoding.

Audio(AudioVar)

Already resolved (loaded or loading) audio.

The audio is passed-through, not cached.

Implementations

impl AudioSource

pub fn from_data(data: IpcBytes, format: AudioDataFormat) -> Self

New source from data.

pub fn hash128(&self, options: &AudioOptions) -> Option<AudioHash>

Returns the audio hash, unless the source is AudioTrack.

pub fn hash128_data(data_hash: AudioHash, options: &AudioOptions) -> AudioHash

Compute hash for a borrowed Data audio.

pub fn hash128_read(path: &Path, options: &AudioOptions) -> AudioHash

Compute hash for a borrowed Read path.

pub fn hash128_download( uri: &Uri, accept: &Option<Txt>, options: &AudioOptions, ) -> AudioHash

Compute hash for a borrowed Download URI and HTTP-ACCEPT.

Trait Implementations

impl Clone for AudioSource

fn clone(&self) -> AudioSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioSource

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

Formats the value using the given formatter.

impl From<&[u8]> for AudioSource

fn from(data: &[u8]) -> Self

From encoded data of Unknown format.

impl<const N: usize> From<&[u8; N]> for AudioSource

fn from(data: &[u8; N]) -> Self

From encoded data of Unknown format.

impl From<&Path> for AudioSource

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<&str> for AudioSource

fn from(s: &str) -> Self

Converts http:// and https:// to Download, file:// to Read the path component, and the rest to Read the string as a path.

impl<F: Into<AudioDataFormat>> From<(&[u8], F)> for AudioSource

fn from((data, format): (&[u8], F)) -> Self

From encoded data of known format.

impl<F: Into<AudioDataFormat>, const N: usize> From<(&[u8; N], F)> for AudioSource

fn from((data, format): (&[u8; N], F)) -> Self

From encoded data of known format.

impl<F: Into<AudioDataFormat>> From<(IpcBytes, F)> for AudioSource

fn from((data, format): (IpcBytes, F)) -> Self

From encoded data of known format.

impl From<(Uri, &'static str)> for AudioSource

fn from((uri, accept): (Uri, &'static str)) -> Self

From (URI, HTTP-ACCEPT).

impl<F: Into<AudioDataFormat>> From<(Vec<u8>, F)> for AudioSource

fn from((data, format): (Vec<u8>, F)) -> Self

From encoded data of known format.

impl From<IpcBytes> for AudioSource

fn from(data: IpcBytes) -> Self

From encoded data of Unknown format.

impl From<PathBuf> for AudioSource

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl From<String> for AudioSource

fn from(s: String) -> Self

Same as conversion from &str.

impl From<Txt> for AudioSource

fn from(s: Txt) -> Self

Same as conversion from &str.

impl From<Uri> for AudioSource

fn from(uri: Uri) -> Self

Converts to this type from the input type.

impl From<Var<AudioTrack>> for AudioSource

fn from(audio: AudioVar) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for AudioSource

fn from(data: Vec<u8>) -> Self

From encoded data of Unknown format.

impl IntoVar<AudioSource> for &[u8]

fn into_var(self) -> Var<AudioSource>

From encoded data of Unknown format.

impl<const N: usize> IntoVar<AudioSource> for &[u8; N]

fn into_var(self) -> Var<AudioSource>

From encoded data of Unknown format.

impl IntoVar<AudioSource> for &Path

fn into_var(self) -> Var<AudioSource>

impl IntoVar<AudioSource> for &str

fn into_var(self) -> Var<AudioSource>

Converts http:// and https:// to Download, file:// to Read the path component, and the rest to Read the string as a path.

impl<F: Into<AudioDataFormat>> IntoVar<AudioSource> for (&[u8], F)

fn into_var(self) -> Var<AudioSource>

From encoded data of known format.

impl<F: Into<AudioDataFormat>, const N: usize> IntoVar<AudioSource> for (&[u8; N], F)

fn into_var(self) -> Var<AudioSource>

From encoded data of known format.

impl<F: Into<AudioDataFormat>> IntoVar<AudioSource> for (IpcBytes, F)

fn into_var(self) -> Var<AudioSource>

From encoded data of known format.

impl IntoVar<AudioSource> for (Uri, &'static str)

fn into_var(self) -> Var<AudioSource>

From (URI, HTTP-ACCEPT).

impl<F: Into<AudioDataFormat>> IntoVar<AudioSource> for (Vec<u8>, F)

fn into_var(self) -> Var<AudioSource>

From encoded data of known format.

impl IntoVar<AudioSource> for IpcBytes

fn into_var(self) -> Var<AudioSource>

From encoded data of Unknown format.

impl IntoVar<AudioSource> for PathBuf

fn into_var(self) -> Var<AudioSource>

impl IntoVar<AudioSource> for String

fn into_var(self) -> Var<AudioSource>

Same as conversion from &str.

impl IntoVar<AudioSource> for Txt

fn into_var(self) -> Var<AudioSource>

Same as conversion from &str.

impl IntoVar<AudioSource> for Uri

fn into_var(self) -> Var<AudioSource>

impl IntoVar<AudioSource> for AudioVar

fn into_var(self) -> Var<AudioSource>

impl IntoVar<AudioSource> for Vec<u8>

fn into_var(self) -> Var<AudioSource>

From encoded data of Unknown format.

impl PartialEq for AudioSource

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl IntoValue<AudioSource> for &[u8]

impl<const N: usize> IntoValue<AudioSource> for &[u8; N]

impl IntoValue<AudioSource> for &Path

impl IntoValue<AudioSource> for &str

impl<F: Into<AudioDataFormat>> IntoValue<AudioSource> for (&[u8], F)

impl<F: Into<AudioDataFormat>, const N: usize> IntoValue<AudioSource> for (&[u8; N], F)

impl<F: Into<AudioDataFormat>> IntoValue<AudioSource> for (IpcBytes, F)

impl IntoValue<AudioSource> for (Uri, &'static str)

impl<F: Into<AudioDataFormat>> IntoValue<AudioSource> for (Vec<u8>, F)

impl IntoValue<AudioSource> for IpcBytes

impl IntoValue<AudioSource> for PathBuf

impl IntoValue<AudioSource> for String

impl IntoValue<AudioSource> for Txt

impl IntoValue<AudioSource> for Uri

impl IntoValue<AudioSource> for AudioVar

impl IntoValue<AudioSource> for Vec<u8>