Skip to main content

Budget

Struct Budget 

Source
pub struct Budget { /* private fields */ }
Expand description

How much of a picture may be kept in memory at once.

Implementations§

Source§

impl Budget

Source

pub fn for_viewport(viewport: ViewportPixels) -> Budget

The budget for showing a picture in a given viewport.

Source

pub fn for_edge(max_edge: u32) -> Budget

A budget with an explicit edge, for a thumbnail or a filmstrip frame, where the size wanted is known exactly.

Source

pub fn fit(&self, source: SourcePixels) -> DecodePixels

What source should be decoded to under this budget.

Aspect ratio is preserved, and a picture already inside the budget is decoded at its own size — never scaled up, which would allocate a buffer of invented pixels.

Source

pub fn allows_source(&self, source: SourcePixels) -> bool

Whether a source this size may be decoded at all.

Source

pub fn limits(&self) -> Limits

The limits handed to image’s decoder, which refuse an absurd file before it allocates rather than after.

Built on Limits::default() rather than no_limits(), which keeps that default’s 512MiB ceiling on decoder allocation.

Worth being precise about what that ceiling does, because it is easy to credit it with more: measured on a 36-megapixel JPEG, the peak is the same with it and without it (509MB either way before the fix in decode). It is not what bounds the transient cost, and the near-match between 509MB and 512MiB is coincidence — the sort of suspiciously round number CLAUDE.md warns is usually somebody else’s limit, which here it was not.

What it does buy is a refusal for a file whose header claims a size no allocator can serve, alongside the two edge caps. That is worth keeping; it is simply not a defence against a large ordinary photograph.

Source

pub fn max_retained_bytes(&self) -> u64

The most an image decoded under this budget can retain, in bytes. What a cache multiplies, and what a test asserts on.

Trait Implementations§

Source§

impl Clone for Budget

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Budget

Source§

impl Debug for Budget

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Budget

Source§

impl PartialEq for Budget

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Budget

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.