Struct ImageLimits

pub struct ImageLimits {
    pub max_encoded_len: ByteLength,
    pub max_decoded_len: ByteLength,
    pub allow_path: PathFilter,
    pub allow_uri: UriFilter,
}

Limits for image loading and decoding.

Fields

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 image memory would surpass the width * height * 4

allow_path: PathFilter

Filter for ImageSource::Read paths.

Only paths allowed by this filter are loaded

allow_uri: UriFilter

Filter for ImageSource::Download URIs.

Implementations

impl ImageLimits

pub fn none() -> Self

No size limits, allow all paths and URIs.

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

Set the max_encoded_len.

pub fn with_max_decoded_len( self, max_decoded_size: 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 ImageLimits

fn clone(&self) -> ImageLimits

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageLimits

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

Formats the value using the given formatter.

impl Default for ImageLimits

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<ImageLimits>> for ImageLimits

type Var = LocalVar<Option<ImageLimits>>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl PartialEq for ImageLimits

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

impl StructuralPartialEq for ImageLimits