Struct ThreadSafeJsValue

pub struct ThreadSafeJsValue<T> { /* private fields */ }

A wrapper around a value that is intended to be passed between threads.

The main use is to wrap JsValue based objects that are not Send or Sync. There is a small overhead to check if the value is on the current thread.

Implementations

impl<T> ThreadSafeJsValue<T>

pub fn new(value: T) -> Self

Creates a new ThreadSafeJsValue.

Example

use wasm_bindgen::JsValue;
use thread_safe_jsvalue::ThreadSafeJsValue;

let value = 42;

let value_ts = ThreadSafeJsValue::new(value);

assert_eq!(value_ts.value(), &42);

impl<T> ThreadSafeJsValue<T>

pub fn is_valid(&self) -> bool

Checks if the ThreadSafeJsValue is valid for the current thread.

pub fn value(&self) -> &T

Gets the value from the ThreadSafeJsValue.

Panics

Panics if the ThreadSafeJsValue is not valid for the current thread.

pub fn try_value(&self) -> Result<&T, Error>

Tries to get the value from the ThreadSafeJsValue.

Trait Implementations

impl<T> Clone for ThreadSafeJsValue<T>

where T: Clone,

fn clone(&self) -> Self

Clones the ThreadSafeJsValue.

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

Performs copy-assignment from source.

impl<T> Debug for ThreadSafeJsValue<T>

where T: Debug,

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

Formats the value for debugging.

Panics

Panics if the ThreadSafeJsValue is not valid for the current thread.

impl<T> Deref for ThreadSafeJsValue<T>

fn deref(&self) -> &Self::Target

Dereferences the value.

Panics

Panics if the ThreadSafeJsValue is not valid for the current thread.

type Target = T

The resulting type after dereferencing.

impl<T> DerefMut for ThreadSafeJsValue<T>

fn deref_mut(&mut self) -> &mut Self::Target

Dereferences the value as a mutable reference.

Panics

Panics if the ThreadSafeJsValue is not valid for the current thread.

impl<T> Display for ThreadSafeJsValue<T>

where T: Display,

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

Formats the value.

Panics

Panics if the ThreadSafeJsValue is not valid for the current thread.

impl<T> Drop for ThreadSafeJsValue<T>

fn drop(&mut self)

Drops the value if it is on the current thread.

Panics

Panics if the value is not on the current thread, except when the value does not need to be dropped.

impl From<JsValue> for ThreadSafeJsValue<JsValue>

fn from(value: JsValue) -> Self

Converts to this type from the input type.

impl<T> Hash for ThreadSafeJsValue<T>

where T: Hash,

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

Hashes the value.

Panics

Panics if the ThreadSafeJsValue is not valid for the current thread.

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<T> Ord for ThreadSafeJsValue<T>

where T: Ord,

fn cmp(&self, other: &Self) -> Ordering

Compares the value for ordering.

Panics

Panics if the ThreadSafeJsValue is not valid for the current thread.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for ThreadSafeJsValue<T>

where T: PartialEq,

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

Compares the value for equality.

Panics

Panics if the ThreadSafeJsValue is not valid for the current thread.

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

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

impl<T> PartialOrd for ThreadSafeJsValue<T>

where T: PartialOrd,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Compares the value for ordering.

Panics

Panics if the ThreadSafeJsValue is not valid for the current thread.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Eq for ThreadSafeJsValue<T>

where T: Eq,

impl<T> Send for ThreadSafeJsValue<T>

Safety

We assert that the thread_id is the same as the current thread_id when we dereference the value.

impl<T> Sync for ThreadSafeJsValue<T>

Safety

We assert that the thread_id is the same as the current thread_id when we dereference the value.