Skip to main content

ExtensionRegistry

Struct ExtensionRegistry 

Source
pub struct ExtensionRegistry { /* private fields */ }
Expand description

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

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

Implementations§

Source§

impl ExtensionRegistry

Source

pub fn new() -> Self

Every provider this module was built with.

Source

pub fn providers(&self) -> String

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

Source

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

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

Source

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

The first claiming provider’s result as JSON { provider, report }, or undefined.

§Errors

If a claiming provider cannot read the bytes.

Source

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

Registers bytes under a locator. Sources read them only during open or render, so a page may register them just for that call (see Self::needs).

Source

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

Forgets the bytes registered under a locator.

Source

pub fn resource_bytes(&self) -> usize

Total bytes registered under locators.

Source

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

Registers a font for SVG text. Sources read fonts when they open.

Source

pub fn clear_fonts(&mut self)

Forgets every registered font; open sources keep theirs.

Source

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

Locators opening a provider source (JSON) reads, as a JSON array.

§Errors

When the provider source is not valid JSON.

Source

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

Locators rendering at a source tick reads that the source does not hold, as a JSON array.

§Errors

When the handle is not open.

Source

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

Opens a provider source (JSON) with its bytes (none for an image sequence) and returns a handle.

§Errors

If the source cannot be opened.

Source

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

What an opened source is, as JSON.

§Errors

When the handle is not open.

Source

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

The frame at a source tick. Vector sources rasterize to fit fit_width by fit_height (0 by 0 for their own size).

§Errors

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

Source

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

Bytes an open source holds between renders (cached frames, images, and file bytes).

§Errors

When the handle is not open.

Source

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

A handle to another independently positioned reader that shares the source’s decoded data. It stays valid after the original is closed. undefined when any time is equally cheap to draw, so the page should share the source.

§Errors

When the handle is not open.

Source

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

The part of Self::resident_bytes shared with Self::reader readers, counted once.

§Errors

When the handle is not open.

Source

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

Closes a source.

Trait Implementations§

Source§

impl Default for ExtensionRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<ExtensionRegistry> for JsValue

Source§

fn from(value: ExtensionRegistry) -> Self

Converts to this type from the input type.
Source§

impl FromWasmAbi for ExtensionRegistry

Source§

type Abi = WasmPtr<WasmRefCell<ExtensionRegistry>>

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

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

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for ExtensionRegistry

Source§

type Abi = WasmPtr<WasmRefCell<ExtensionRegistry>>

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

fn into_abi(self) -> Self::Abi

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

impl LongRefFromWasmAbi for ExtensionRegistry

Source§

type Abi = WasmPtr<WasmRefCell<ExtensionRegistry>>

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<ExtensionRegistry>

Same as RefFromWasmAbi::Anchor
Source§

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

Same as RefFromWasmAbi::ref_from_abi
Source§

impl OptionFromWasmAbi for ExtensionRegistry

Source§

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.
Source§

impl OptionIntoWasmAbi for ExtensionRegistry

Source§

fn none() -> Self::Abi

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

impl RefFromWasmAbi for ExtensionRegistry

Source§

type Abi = WasmPtr<WasmRefCell<ExtensionRegistry>>

The Wasm ABI type references to Self are recovered from.
Source§

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.
Source§

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

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for ExtensionRegistry

Source§

type Abi = WasmPtr<WasmRefCell<ExtensionRegistry>>

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<ExtensionRegistry>

Same as RefFromWasmAbi::Anchor
Source§

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

Same as RefFromWasmAbi::ref_from_abi
Source§

impl SupportsConstructor for ExtensionRegistry

Source§

impl SupportsInstanceProperty for ExtensionRegistry

Source§

impl SupportsStaticProperty for ExtensionRegistry

Source§

impl TryFromJsValue for ExtensionRegistry

Source§

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

Performs the conversion.
Source§

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

Performs the conversion.
Source§

impl VectorFromWasmAbi for ExtensionRegistry

Source§

impl VectorIntoWasmAbi for ExtensionRegistry

Source§

impl WasmDescribe for ExtensionRegistry

Source§

impl WasmDescribeVector for ExtensionRegistry

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more