Skip to main content

Serializer

Trait Serializer 

Source
pub trait Serializer: Sized {
    // Required method
    fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>;

    // Provided method
    fn try_to_vec(&self) -> Result<Vec<u8>> { ... }
}
Expand description

Serializer is a trait that allows for data serialization and deserialization similar to Borsh, but via a separate trait. This allows for serialization of additional metadata while using underlying Borsh primitives. For example: a struct can implement both Borsh and Serializer traits where Serializer can store custom metadata (e.g. struct version) and then store the struct using Borsh. Both Serializer and Borsh are almost identical, where Serializer is meant to signal intent for custom serialization. Serializer is a complimentary trait for Serializable struct and can be used to prevent direct Borsh serialization of a struct.

Required Methods§

Source

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Writes the serialized representation of self to the given writer.

Provided Methods§

Source

fn try_to_vec(&self) -> Result<Vec<u8>>

Serializes self into a newly allocated byte vector.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types§

Source§

impl Serializer for String

Source§

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Source§

impl<K, V> Serializer for AHashMap<K, V>
where K: Serializer + Send + Sync + Hash + Eq, V: Serializer + Send + Sync,

Source§

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Source§

impl<K, V> Serializer for BTreeMap<K, V>
where K: Serializer + Ord, V: Serializer,

Source§

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Source§

impl<K, V> Serializer for HashMap<K, V>
where K: Serializer + Hash + Eq, V: Serializer,

Source§

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Source§

impl<T, E> Serializer for Result<T, E>
where T: Serializer + 'static, E: Display + BorshSerialize + 'static,

Source§

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Source§

impl<T> Serializer for AHashSet<T>
where T: Serializer + Hash + Eq,

Source§

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Source§

impl<T> Serializer for BTreeSet<T>
where T: Serializer + Ord,

Source§

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Source§

impl<T> Serializer for HashSet<T>
where T: Serializer + Send + Sync + Hash + Eq,

Source§

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Source§

impl<T> Serializer for Option<T>
where T: Serializer + 'static,

Source§

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Source§

impl<V> Serializer for Vec<V>
where V: Serializer,

Source§

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

Implementors§

Source§

impl<T> Serializer for Payload<'_, T>
where T: Serializer,