Struct AudioLimits 

#[non_exhaustive]
pub struct AudioLimits {
    pub max_encoded_len: ByteLength,
    pub max_decoded_len: ByteLength,
    pub allow_path: PathFilter,
    pub allow_uri: UriFilter,
}

Limits for audio loading and decoding.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_encoded_len: ByteLength

Maximum encoded file size allowed.

An error is returned if the file size surpasses this value. If the size can read before read/download the validation happens before download starts, otherwise the error happens when this limit is reached and all already downloaded bytes are dropped.

The default is 100mb.

max_decoded_len: ByteLength

Maximum decoded file size allowed.

An error is returned if the decoded audio memory (width * height * 4) would surpass this.

allow_path: PathFilter

Filter for AudioSource::Read paths.

allow_uri: UriFilter

Filter for AudioSource::Download URIs.

Implementations

impl AudioLimits

pub fn none() -> Self

No size limits, allow all paths and URIs.

pub fn with_max_encoded_len( self, max_encoded_len: impl Into<ByteLength>, ) -> Self

Set the max_encoded_len.

pub fn with_max_decoded_len( self, max_decoded_len: impl Into<ByteLength>, ) -> Self

Set the max_decoded_len.

pub fn with_allow_path(self, allow_path: impl Into<PathFilter>) -> Self

Set the allow_path.

pub fn with_allow_uri(self, allow_url: impl Into<UriFilter>) -> Self

Set the allow_uri.

Trait Implementations

impl Clone for AudioLimits

fn clone(&self) -> AudioLimits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioLimits

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

Formats the value using the given formatter.

impl Default for AudioLimits

fn default() -> Self

100 megabytes encoded and 4096 megabytes decoded (BMP max).

Allows only paths in zng::env::res, blocks all downloads.

impl IntoVar<Option<AudioLimits>> for AudioLimits

fn into_var(self) -> Var<Option<AudioLimits>>

impl PartialEq for AudioLimits

fn eq(&self, other: &AudioLimits) -> 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<Option<AudioLimits>> for AudioLimits

impl StructuralPartialEq for AudioLimits