Struct SharedValue

pub struct SharedValue<T, Ser = JsonSerdeCodec> { /* private fields */ }

A smart pointer that allows you to share identical, synchronously-loaded data between the server and the client.

If this constructed on the server, it serializes its value into the shared context. If it is constructed on the client during hydration, it reads its value from the shared context. If it it constructed on the client at any other time, it simply runs on the client.

Implementations

impl<T, Ser> SharedValue<T, Ser>

pub fn into_inner(self) -> T

Returns the inner value.

impl<T> SharedValue<T, JsonSerdeCodec>

where JsonSerdeCodec: Encoder<T> + Decoder<T>, <JsonSerdeCodec as Encoder<T>>::Error: Debug, <JsonSerdeCodec as Decoder<T>>::Error: Debug, <JsonSerdeCodec as Encoder<T>>::Encoded: IntoEncodedString, <JsonSerdeCodec as Decoder<T>>::Encoded: FromEncodedStr, <<JsonSerdeCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,

pub fn new(initial: impl FnOnce() -> T) -> Self

Wraps the initial value.

If this is on the server, the function will be invoked and the value serialized. When it runs on the client, it will be deserialized without running the function again.

This uses the JsonSerdeCodec encoding.

impl<T> SharedValue<T, FromToStringCodec>

where FromToStringCodec: Encoder<T> + Decoder<T>, <FromToStringCodec as Encoder<T>>::Error: Debug, <FromToStringCodec as Decoder<T>>::Error: Debug, <FromToStringCodec as Encoder<T>>::Encoded: IntoEncodedString, <FromToStringCodec as Decoder<T>>::Encoded: FromEncodedStr, <<FromToStringCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,

pub fn new_str(initial: impl FnOnce() -> T) -> Self

Wraps the initial value.

If this is on the server, the function will be invoked and the value serialized. When it runs on the client, it will be deserialized without running the function again.

This uses the FromToStringCodec encoding.

impl<T, Ser> SharedValue<T, Ser>

where Ser: Encoder<T> + Decoder<T>, <Ser as Encoder<T>>::Error: Debug, <Ser as Decoder<T>>::Error: Debug, <Ser as Encoder<T>>::Encoded: IntoEncodedString, <Ser as Decoder<T>>::Encoded: FromEncodedStr, <<Ser as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,

pub fn new_with_encoding(initial: impl FnOnce() -> T) -> Self

Wraps the initial value.

If this is on the server, the function will be invoked and the value serialized. When it runs on the client, it will be deserialized without running the function again.

This uses Ser as an encoding.

Trait Implementations

impl<T: Debug, Ser: Debug> Debug for SharedValue<T, Ser>

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

Formats the value using the given formatter.

impl<T, Ser> Deref for SharedValue<T, Ser>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, Ser> DerefMut for SharedValue<T, Ser>

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

Mutably dereferences the value.

impl<T, Ser> Display for SharedValue<T, Ser>

where T: Display,

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

Formats the value using the given formatter.

impl<T, Ser> Hash for SharedValue<T, Ser>

where T: Hash,

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<T, Ser> Ord for SharedValue<T, Ser>

where T: Ord,

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

This method returns an Ordering between self and other.

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, Ser> PartialEq for SharedValue<T, Ser>

where T: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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, Ser> PartialOrd for SharedValue<T, Ser>

where T: PartialOrd,

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

This method returns an ordering between self and other values if one exists.

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, Ser> Eq for SharedValue<T, Ser>

where T: Eq,