Struct ark_api::resource::ResourceHandle

pub struct ResourceHandle { /* private fields */ }

Represents a handle to unique resource

In-process serialization is supported through speedy. However, this handle should not be persisted across module sessions.

Implementations

impl ResourceHandle

pub fn request(name: &str) -> Self

Request the latest version of a resource given the provided name

This will start downloading the resource if it isn’t present in Ark

pub fn try_retrieve(&self) -> Option<Vec<u8>>

Retrieve the resource’s data by copying it into Wasm memory

Returns None if the resource hasn’t finished downloading

If you only want to check if a resource is ready, use Self::is_ready instead

pub fn is_ready(&self) -> bool

Check if the resource is available for use

pub fn raw(&self) -> ResourceHandleRepr

Retrieve the raw inner ResourceHandleRepr

Useful for passing to other Ark APIs that can operate on resources

TODO: return a concrete type that can be shared between Ark APIs

Trait Implementations

impl Clone for ResourceHandle

fn clone(&self) -> ResourceHandle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResourceHandle

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

Formats the value using the given formatter.

impl Hash for ResourceHandle

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<ResourceHandle> for ResourceHandle

fn eq(&self, other: &ResourceHandle) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a_, C_: Context> Readable<'a_, C_> for ResourceHandle

fn read_from<R_: Reader<'a_, C_>>(_reader_: &mut R_) -> Result<Self, C_::Error>

fn minimum_bytes_needed() -> usize

fn read_from_buffer_with_ctx( context: C, buffer: &'a [u8] ) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_with_ctx( context: C, buffer: &'a [u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8] ) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_with_length_from_buffer_copying_data_with_ctx_mut( context: &mut C, buffer: &[u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_stream_unbuffered_with_ctx<S>( context: C, stream: S ) -> Result<Self, <C as Context>::Error>where S: Read,

fn read_from_stream_buffered_with_ctx<S>( context: C, stream: S ) -> Result<Self, <C as Context>::Error>where S: Read,

fn read_from_file_with_ctx( context: C, path: impl AsRef<Path> ) -> Result<Self, <C as Context>::Error>

impl<C_: Context> Writable<C_> for ResourceHandle

fn write_to<T_: ?Sized + Writer<C_>>( &self, _writer_: &mut T_ ) -> Result<(), C_::Error>

fn write_to_buffer_with_ctx( &self, context: C, buffer: &mut [u8] ) -> Result<(), <C as Context>::Error>

fn write_to_buffer_with_ctx_mut( &self, context: &mut C, buffer: &mut [u8] ) -> Result<(), <C as Context>::Error>

fn write_to_vec_with_ctx( &self, context: C ) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_vec_with_ctx_mut( &self, context: &mut C ) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_stream_with_ctx<S>( &self, context: C, stream: S ) -> Result<(), <C as Context>::Error>where S: Write,

fn write_to_file_with_ctx( &self, context: C, path: impl AsRef<Path> ) -> Result<(), <C as Context>::Error>

fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>

impl Eq for ResourceHandle

impl StructuralEq for ResourceHandle

impl StructuralPartialEq for ResourceHandle