Struct MemoryScopes 

#[non_exhaustive]
pub struct MemoryScopes {
    pub tag: fn(u8, &'static str) -> u16,
    pub enter: fn(u16) -> u16,
    pub leave: fn(u16),
}

How a backend lets the engine tag what it allocates (ADR-0046 §6): three plain functions over its heap counter’s tags (shuyi_platform::Platform::memory_scopes), so neither this crate nor the platform depends on the counter. Build it with MemoryScopes::new (ADR-0039).

With scopes in its context (Ctx::set_memory_scopes), the game’s frame enters update and draw, each Ctx::span its own name, and the platform’s App its own phases. Entering a tag changes nothing a game reads.

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.

tag: fn(u8, &'static str) -> u16

The tag of a name of a class (TagClass as a number), the same each time it is asked for.

enter: fn(u16) -> u16

Makes a tag the current one, and gives back the one before.

leave: fn(u16)

Puts back the tag enter gave.

Implementations

impl MemoryScopes

pub const fn new( tag: fn(u8, &'static str) -> u16, enter: fn(u16) -> u16, leave: fn(u16), ) -> Self

Scopes that find a tag with tag, and enter and leave it.

pub fn enter(&self, class: TagClass, name: &'static str) -> u16

Enters the tag of class’s name, and gives back the tag before, for leave.

pub fn leave(&self, before: u16)

Puts back before, the tag enter gave.

Trait Implementations

impl Clone for MemoryScopes

fn clone(&self) -> MemoryScopes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MemoryScopes

impl Debug for MemoryScopes

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

Formats the value using the given formatter.