Pre-1.0: signatures are not frozen. Generated from rustdoc JSON of the compiled crate; rustdoc JSON format version 60. Only public items are listed.
Bounded CPU producer buffers and immutable consumer leases.
A retained recording holds the same Arc<ImageResource> as a lease. That
allocation cannot be written again while a recording, lease, clone or Weak
reference exists. Latest publication and physical display are distinct.
Structs
structaster_ui::frames::FrameId
pub struct FrameId { /* see fields */ }Pool-local monotonic publication identity. Producer media time is separate.
Methods
fn sequence(self) -> u64
Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
structaster_ui::frames::FrameLease
pub struct FrameLease { /* see fields */ }Clone/transfer is a reference-count operation, not a pixel copy.
Methods
fn stamp(&self) -> FrameStampfn image(&self) -> &Arc<ImageResource>fn pixels(&self) -> &[u8]
Trait implementations: Clone, Debug
structaster_ui::frames::FramePool
pub struct FramePool { /* see fields */ }Cold allocation. Fixed descriptor, 2..=64 buffers, at most1GiB pixel storage. No producer operation resizes an allocation or evicts an outstanding lease.
Methods
fn new(descriptor: ImageDescriptor, buffers: usize, pixel_byte_budget: usize) -> Result<Self, FrameError>— The budget covers actual pixel Vec capacity. Descriptor/slot storage is reported separately; Arc/allocator metadata and shared alpha tables are excluded. The last published buffer is protected even without readers.fn descriptor(&self) -> ImageDescriptorfn buffer_count(&self) -> usizefn reserved_pixel_bytes(&self) -> usizefn reserved_bytes(&self) -> usize— Includes slot Vec capacity and pixel Vec capacities, excludes Arc and allocator metadata, this struct and fixed shared conversion tables.fn latest(&self) -> Option<FrameLease>fn begin(&mut self) -> Result<FrameWriter<'_>, FrameError>— Choose a retired, uniquely owned buffer. Backpressure never waits, allocates, drops a reader or silently replaces latest publication.fn clear(&mut self)— Withdraw latest discovery; existing immutable leases remain valid. IDs never reset, and no buffer with outstanding references is reclaimed.
structaster_ui::frames::FrameStamp
pub struct FrameStamp { /* see fields */ }Public fields
| field | type | |
|---|---|---|
id | FrameId | |
image | super::ImageId | |
media_time_ns | u64 | Opaque producer time. May move backwards when media seeks. |
Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
structaster_ui::frames::FrameWriter
pub struct FrameWriter<'a> { /* see fields */ }Exclusive producer access. Drop abandons these edits without publication. Bytes are initialized retired-slot contents; callers must write a complete frame or deliberately clear it. No same-slot history across begins is promised.
Methods
fn descriptor(&self) -> ImageDescriptorfn pixels_mut(&mut self) -> &mut [u8]fn copy_from(&mut self, pixels: &[u8]) -> Result<(), FrameError>fn publish(self, media_time_ns: u64) -> Result<FrameLease, FrameError>— Validate and publish atomically. Media timestamp is metadata, not host presentation acknowledgement. Every success gets a fresh ImageId.
Enums
enumaster_ui::frames::FrameError
pub enum FrameError { Resource, Backpressure, SequenceExhausted }Variants
ResourceBackpressureSequenceExhausted
Trait implementations: Clone, Copy, Debug, Display, Eq, Error, From<Error>, PartialEq, StructuralPartialEq