Struct Reservation 

pub struct Reservation { /* private fields */ }

One track’s standing claim on an Allocator, held for as long as the sender that took it is publishing.

Separate from the Consumer that reads the slice, because the two have opposite lifetimes: read handles are cloned around and dropped freely, while the claim itself has to outlive every one of them or the sender silently stops claiming anything.

Implementations

impl Reservation

pub fn peek(&self) -> Option<Rate>

This reservation’s slice right now.

Stateless, unlike Consumer::changed, which carries a cursor over what it last reported and so needs a handle of its own.

pub fn consumer(&self) -> Consumer

A handle reading this reservation’s current slice of the estimate.

Cloneable and independent of the reservation: once the reservation is dropped these report None, the same “hold your rate” a track nobody is watching reports.

pub fn update(&self, max: Rate)

Change the ceiling, keeping the same claim.

For a sender whose ceiling genuinely moved: an encoder reopening at a resolution it negotiated with the device, not an encoder observing its own output. A reservation that followed the rate a VBR source happens to be sending would hand the room away every time the picture went still, and not have it back when the picture moved again.

Does nothing once every Allocator is gone, since there is then nothing left dividing anything; a reader learns that from its consumer.

Trait Implementations

impl Drop for Reservation

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.