Struct Extractor

pub struct Extractor { /* private fields */ }

Decompresses Oodle data to a buffer. Methods are provided for various input types, depending on crate features.

Implementations

impl Extractor

pub fn extract( &mut self, input: Vec<u8>, output_size: usize, ) -> Result<Vec<u8>, JsError>

impl Extractor

pub fn new() -> Extractor

impl Extractor

pub fn read<In: Read>( &mut self, input: &mut In, output: &mut [u8], ) -> Result<usize, OozError>

Extracts from an instance of std::io::Read

Input is assumed to be buffered; wrapping unbuffered input with std::io::BufReader may improve performance

output should be exactly large enough to hold the uncompressed data

pub fn read_from_slice( &mut self, input: &[u8], output: &mut [u8], ) -> Result<usize, OozError>

Extracts from a byte slice

output should be exactly large enough to hold the uncompressed data

pub async fn async_read<In: AsyncRead + Unpin>( &mut self, input: &mut In, output: &mut [u8], ) -> Result<usize, OozError>

Available on crate feature tokio only.

Extracts from an instance of tokio::io::AsyncRead

Input is assumed to be buffered; wrapping unbuffered input with tokio::io::BufReader may improve performance

output should be exactly large enough to hold the uncompressed data

pub async fn read_from_stream<E: 'static + Error + Send + Sync, In: Stream<Item = Result<Bytes, E>> + Unpin>( &mut self, stream: &mut In, current: Option<Bytes>, output: &mut [u8], ) -> Result<(usize, Option<Bytes>), OozError>

Available on crate feature async only.

Extracts from an instance of futures::stream::Stream

Bytes in current will be prepended to the stream; the Option returned by this method should be passed in to the next read_from_stream call when extracting multiple compressed blocks from a stream.

output should be exactly large enough to hold the uncompressed data

Trait Implementations

impl From<Extractor> for JsValue

fn from(value: Extractor) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Extractor

type Abi = u32

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

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Extractor

type Abi = u32

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

fn into_abi(self) -> u32

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

impl LongRefFromWasmAbi for Extractor

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<Extractor>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Extractor

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 Extractor

fn none() -> Self::Abi

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

impl RefFromWasmAbi for Extractor

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<Extractor>

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 Extractor

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<Extractor>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for Extractor

type Error = JsValue

The type returned in the event of a conversion error.

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

Performs the conversion.

impl VectorFromWasmAbi for Extractor

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

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

impl VectorIntoJsValue for Extractor

fn vector_into_jsvalue(vector: Box<[Extractor]>) -> JsValue

impl VectorIntoWasmAbi for Extractor

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

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

impl WasmDescribe for Extractor

fn describe()

impl WasmDescribeVector for Extractor

fn describe_vector()

impl SupportsConstructor for Extractor

impl SupportsInstanceProperty for Extractor

impl SupportsStaticProperty for Extractor