Struct leptos_use::utils::ProstCodec

pub struct ProstCodec;

A codec for storing ProtoBuf messages that relies on prost to parse.

Protocol buffers is a serialisation format useful for long-term storage. It provides semantics for versioning that are not present in JSON or other formats. prost is a Rust implementation of Protocol Buffers.

This codec uses prost to encode the message and then base64 to represent the bytes as a string.

Example

// Primitive types:
let (get, set, remove) = use_local_storage::<i32, ProstCodec>("my-key");

// Structs:
#[derive(Clone, PartialEq, prost::Message)]
pub struct MyState {
    #[prost(string, tag = "1")]
    pub hello: String,
}
let (get, set, remove) = use_local_storage::<MyState, ProstCodec>("my-struct-key");

Note: we’ve defined and used the prost attribute here for brevity. Alternate usage would be to describe the message in a .proto file and use prost_build to auto-generate the Rust code.

Trait Implementations

impl Clone for ProstCodec

fn clone(&self) -> ProstCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ProstCodec

fn default() -> ProstCodec

Returns the “default value” for a type.

impl PartialEq for ProstCodec

fn eq(&self, other: &ProstCodec) -> 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<T: Default + Message> StringCodec<T> for ProstCodec

type Error = ProstCodecError

The error type returned when encoding or decoding fails.

fn encode(&self, val: &T) -> Result<String, Self::Error>

Encodes a value to a string.

fn decode(&self, str: String) -> Result<T, Self::Error>

Decodes a string to a value. Should be able to decode any string encoded by [encode].

impl Copy for ProstCodec

impl StructuralPartialEq for ProstCodec