Struct ExtensionRegistry 

pub struct ExtensionRegistry { /* private fields */ }

The providers this module was built with, and the sources a page opened.

Failures are thrown as plain string messages, not Error objects.

Implementations

impl ExtensionRegistry

pub fn new() -> Self

Every provider this module was built with.

pub fn providers(&self) -> String

The providers’ names, in priority order, as a JSON array.

pub fn supports(&self, provider: &str) -> bool

Whether this module opens a project’s provider source (JSON).

pub fn probe(&self, bytes: &[u8]) -> Result<Option<String>, JsValue>

What the first provider that claims bytes finds, as JSON { provider, report }, or undefined when none does.

Errors

Why bytes a provider claims cannot be read.

pub fn register_resource(&mut self, locator: String, bytes: Vec<u8>)

Registers bytes under a locator: an image sequence’s frame, or an image an SVG names. A source reads them when it opens or renders, so a page may register them only for that call (see Self::needs).

pub fn release_resource(&mut self, locator: &str)

Forgets the bytes registered under a locator.

pub fn resource_bytes(&self) -> usize

The bytes registered under locators, all together.

pub fn register_font(&mut self, bytes: Vec<u8>)

Registers a font an SVG’s text may draw with, after those registered before. A source reads the fonts when it opens.

pub fn clear_fonts(&mut self)

Forgets every registered font. Sources opened before keep the fonts they opened with.

pub fn open_needs(&self, provider: &str) -> Result<String, JsValue>

The resources opening a project’s provider source (JSON) reads, as a JSON array of locators: an image sequence’s first frame.

Errors

When the provider source is not valid JSON.

pub fn needs(&self, handle: u32, time_ticks: i64) -> Result<String, JsValue>

The resources rendering a source at a source tick reads, as a JSON array of locators: those it does not already hold.

Errors

When the handle is not open.

pub fn open( &mut self, provider: &str, bytes: Option<Vec<u8>>, ) -> Result<u32, JsValue>

Opens a project’s provider source (JSON) with its own bytes (none for an image sequence), returning a handle.

Errors

Why the source cannot be opened.

pub fn report(&self, handle: u32) -> Result<String, JsValue>

What an opened source is, as JSON.

Errors

When the handle is not open.

pub fn render( &mut self, handle: u32, time_ticks: i64, fit_width: u32, fit_height: u32, ) -> Result<RenderedFrame, JsValue>

The frame a source shows at a source tick, rasterized to fit fit_width by fit_height when it is a vector source (0 by 0 for its own size).

Errors

When the handle is not open or the frame cannot be produced.

pub fn resident_bytes(&self, handle: u32) -> Result<usize, JsValue>

The bytes an opened source holds between renders: its decoded frames and images, its last rendered frame, its file’s bytes when it keeps them. A page that bounds what its open sources hold counts this.

Errors

When the handle is not open.

pub fn reader(&mut self, handle: u32) -> Result<Option<u32>, JsValue>

Another reader of an opened source, positioned on its own, returning its handle: it shares what the source decoded when it opened (an animation’s file, checked frames, and kept frames) with the source and every other reader made from either, and decodes on its own. The readers stay valid when the source they were made from is released. undefined for a source that draws any time as cheaply, which a page shares instead.

Errors

When the handle is not open.

pub fn shared_bytes(&self, handle: u32) -> Result<usize, JsValue>

Of Self::resident_bytes, what the source shares with the readers made from it (Self::reader): the same bytes for each, which a page counts once.

Errors

When the handle is not open.

pub fn release(&mut self, handle: u32)

Closes a source.

Trait Implementations

impl Default for ExtensionRegistry

fn default() -> Self

Returns the “default value” for a type.

impl From<ExtensionRegistry> for JsValue

fn from(value: ExtensionRegistry) -> Self

Converts to this type from the input type.

impl FromWasmAbi for ExtensionRegistry

type Abi = WasmPtr<WasmRefCell<ExtensionRegistry>>

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for ExtensionRegistry

type Abi = WasmPtr<WasmRefCell<ExtensionRegistry>>

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for ExtensionRegistry

type Abi = WasmPtr<WasmRefCell<ExtensionRegistry>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<ExtensionRegistry>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for ExtensionRegistry

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for ExtensionRegistry

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for ExtensionRegistry

type Abi = WasmPtr<WasmRefCell<ExtensionRegistry>>

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<ExtensionRegistry>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for ExtensionRegistry

type Abi = WasmPtr<WasmRefCell<ExtensionRegistry>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<ExtensionRegistry>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl SupportsConstructor for ExtensionRegistry

impl SupportsInstanceProperty for ExtensionRegistry

impl SupportsStaticProperty for ExtensionRegistry

impl TryFromJsValue for ExtensionRegistry

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for ExtensionRegistry

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[ExtensionRegistry]>

impl VectorIntoWasmAbi for ExtensionRegistry

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[ExtensionRegistry]>) -> Self::Abi

impl WasmDescribe for ExtensionRegistry

fn describe()

impl WasmDescribeVector for ExtensionRegistry

fn describe_vector()