Struct BinaryAssets 

pub struct BinaryAssets { /* private fields */ }

One world’s binary payload store. Explicit collection keeps only caller-supplied reachable handles; graph ownership, not a run’s lifetime, determines reachability. Host pins must be included along with graph references when collecting.

Implementations

impl BinaryAssets

pub fn with_limits(limits: BinaryLimits) -> Self

Empty store with host-selected allocation limits.

pub fn byte_len(&self) -> usize

Retained decoded bytes, excluding map and index overhead.

pub fn len(&self) -> usize

Distinct retained payloads.

pub fn is_empty(&self) -> bool

Whether no payload is retained.

pub fn get(&self, id: BinaryId) -> Result<&[u8], BinaryError>

Borrow an asset’s bytes, or return BinaryError::Missing.

pub fn insert(&mut self, bytes: Vec<u8>) -> Result<BinaryId, BinaryError>

Retain bytes once, deduplicated by SHA-256. Return a limit error when allocation bounds are exceeded or a corruption error on a hash collision.

pub fn intern( &mut self, source: DocumentSourceKind, ) -> Result<PartSource, BinaryError>

Convert a transport source to graph data. Repeated encoded strings are decoded once while their cached spelling and asset remain retained. Returns errors for invalid base64, allocation limits, or inconsistent assets.

pub fn resolve( &self, source: &PartSource, ) -> Result<DocumentSourceKind, BinaryError>

Rebuild the transport source with its saved spelling, returning an error for missing bytes, invalid spelling metadata, or size overflow.

pub fn retain( &mut self, roots: impl IntoIterator<Item = BinaryId>, ) -> Result<(), BinaryError>

Drop assets unreachable from all graph references and explicit host pins. Missing roots are an error and leave the store unchanged.

pub fn iter(&self) -> impl Iterator<Item = (BinaryId, &[u8])>

Assets in deterministic content-hash order for scene construction.

pub fn from_payloads( payloads: impl IntoIterator<Item = (BinaryId, Vec<u8>)>, limits: BinaryLimits, ) -> Result<Self, BinaryError>

Validate all saved identities and limits in an isolated store. The caller installs it only after graph handles and the rest of the scene validate. Returns an error for incorrect hashes, duplicate IDs, or exceeded limits.

impl BinaryAssets

pub fn snapshot(&self) -> Vec<BinaryRecord>

Snapshot the retained store in content-hash order.

pub fn merged(&self, records: &[BinaryRecord]) -> Result<Self, BinaryError>

Build an isolated merged store using the destination’s limits. Invalid hashes, duplicate saved IDs, invalid base64, or allocation excess return an error without mutating the destination.

Trait Implementations

impl Component for BinaryAssets

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for BinaryAssets

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

Formats the value using the given formatter.

impl Default for BinaryAssets

fn default() -> Self

Returns the “default value” for a type.

impl Resource for BinaryAssets

where Self: Send + Sync + 'static,