Struct RetainedKey 

pub struct RetainedKey(pub u64);

The identity of a retained page: mint one with RetainedKey::mint and hand it to PaintScene::push_retained/draw_retained, asking PaintCtx::retained_available whether the renderer still holds the page. The identity of one retained page. A renderer caches a page’s rasterized body by key alone, so two unrelated owners sharing a key would alias each other’s content; every key is minted from one process-wide counter so none can collide.

Tuple Fields

0: u64

Implementations

impl RetainedKey

pub fn mint() -> RetainedKey

Mint a fresh key, distinct from every other key minted in the process.

pub fn mint_range(count: u64) -> RetainedKey

Reserve count consecutive keys and return the first (first, first + 1, …). For an owner that needs a fixed set of related keys (a switcher’s outgoing/incoming pair). count == 0 reserves nothing.

pub fn get(self) -> u64

The raw key as handed to PaintScene::push_retained/draw_retained.

Trait Implementations

impl Clone for RetainedKey

fn clone(&self) -> RetainedKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RetainedKey

impl Debug for RetainedKey

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

Formats the value using the given formatter.

impl Eq for RetainedKey

impl From<u64> for RetainedKey

fn from(raw: u64) -> RetainedKey

Converts to this type from the input type.

impl Hash for RetainedKey

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RetainedKey

fn cmp(&self, other: &RetainedKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for RetainedKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RetainedKey

fn partial_cmp(&self, other: &RetainedKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for RetainedKey