Struct Registry 

pub struct Registry { /* private fields */ }

The providers a host’s build includes, highest priority first.

Implementations

impl Registry

pub fn with_defaults() -> Self

A registry of every provider this build includes, in the default priority: SVG, animated images, Lottie, then OpenEXR.

pub fn register(&mut self, provider: Box<dyn VisualProvider>)

Adds provider after those already registered.

pub fn names(&self) -> Vec<&'static str>

The registered providers’ names, in priority order.

pub fn probe( &self, bytes: &[u8], ) -> Option<Result<(&'static str, ProbeReport), ExtensionError>>

What the first provider that claims bytes finds, or None when none does. A provider that claims them and fails answers with its error: another provider is not tried in its place.

pub fn supports(&self, source: &ProviderSource) -> bool

Whether this build opens source.

pub const fn reads_image_sequences() -> bool

Whether this build reads image sequences. They have no provider to register (each frame is a PNG or an OpenEXR image), so Self::names cannot say.

pub fn open_needs(&self, source: &ProviderSource) -> Vec<String>

The resources opening source reads, by locator: an image sequence’s first frame. A host that registers resources only while they are used registers these before Self::open.

pub fn open( &self, source: &ProviderSource, bytes: Option<Arc<[u8]>>, resolver: SharedResolver, ) -> Result<Box<dyn VisualSource>, ExtensionError>

Opens a project’s provider source: the bytes at its locator (none for an image sequence, whose frames resolver supplies). The bytes must be what the project says they are. An image sequence keeps resolver and reads each frame from it as it shows it; other providers read what they need while they open.

The source renders through the same panic boundary: a render that panics fails, and so does every later one, without running the provider’s code again on state the panic left behind.

Errors

ExtensionError::Unsupported when this build has no provider for it, ExtensionError::Mismatch when the bytes are another format, or why the provider cannot open them (ExtensionError::Malformed when it panicked).

Trait Implementations

impl Default for Registry

fn default() -> Self

Returns the “default value” for a type.