Struct Serialized

pub struct Serialized { /* private fields */ }

Represents a serialized value, wrapping the underlying serialization and deserialization details, while ensuring that we pass correctly-serialized message throughout the system.

Currently, Serialized passes through to bincode, but in the future we may include content-encoding information to allow for other codecs as well.

Implementations

impl Serialized

pub fn serialize<T: Serialize + Named>(value: &T) -> Result<Self, Error>

Construct a new serialized value by serializing the provided T-typed value.

pub fn serialize_anon<T: Serialize>(value: &T) -> Result<Self, Error>

Construct a new anonymous (unnamed) serialized value by serializing the provided T-typed value.

pub fn deserialized<T: DeserializeOwned>(&self) -> Result<T, Error>

Deserialize a value to the provided type T.

pub fn transcode_to_json(self) -> Result<Self, Self>

Transcode the serialized value to JSON. This operation will succeed if the type hash is embedded in the value, and the corresponding type is available in this binary.

pub fn dump(&self) -> Result<Value, Error>

Dump the Serialized message into a JSON value. This will succeed if: 1) the typehash is embedded in the serialized value; 2) the named type is linked into the binary.

pub fn typehash(&self) -> Option<u64>

The typehash of the serialized value, if available.

pub fn typename(&self) -> Option<&'static str>

The typename of the serialized value, if available.

pub fn prefix<T: DeserializeOwned>(&self) -> Result<T, Error>

Deserialize a prefix of the value. This is currently only supported for bincode-serialized values.

pub fn emplace_prefix<T: Serialize + DeserializeOwned>( &mut self, prefix: T, ) -> Result<(), Error>

Emplace a new prefix to this value. This is currently only supported for bincode-serialized values.

pub fn len(&self) -> usize

The length of the underlying serialized message

pub fn is_empty(&self) -> bool

Is the message empty. This should always return false.

pub fn crc(&self) -> u32

Returns the 32bit crc of the serialized data

Trait Implementations

impl Clone for Serialized

fn clone(&self) -> Serialized

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Serialized

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Serialized

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Serialized

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

Formats the value using the given formatter.

impl PartialEq for Serialized

fn eq(&self, other: &Serialized) -> 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 Serialize for Serialized

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Serialized