Struct holochain_serialized_bytes::SerializedBytes

pub struct SerializedBytes(/* private fields */);

A Canonical Serialized Bytes representation for data If you have a data structure that needs a canonical byte representation use this Always round-trip through SerializedBytes via. a single TryFrom implementation. This ensures that the internal bytes of SerializedBytes are indeed canonical. The corrolary is that if bytes are NOT wrapped in SerializedBytes we can assume they are NOT canonical. Typically we need a canonical serialization when data is to be handled at the byte level by independently implemented and maintained systems.

Examples of times we need a canonical set of bytes to represent data:

• cryptographic operations
• moving across the host/guest wasm boundary
• putting data on the network

Examples of times where we may not need a canonical representation and so may not need this:

• round tripping data through a database that has its own serialization preferences
• debug output or logging of data that is to be human readible
• moving between data types within a single system that has no external facing representation

uses #[repr(transparent)] to maximise compatibility with ffi @see https://doc.rust-lang.org/1.26.2/unstable-book/language-features/repr-transparent.html#enter-reprtransparent

uses serde_bytes for efficient serialization and deserialization without this every byte will be individually round tripped through serde @see https://crates.io/crates/serde_bytes

Implementations

impl SerializedBytes

pub fn bytes(&self) -> &Vec<u8>

Trait Implementations

impl Clone for SerializedBytes

fn clone(&self) -> SerializedBytes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SerializedBytes

A bit of magic to convert the internal messagepack bytes into roughly equivalent JSON output for the purposes of debugging. 90% of the time you probably want this if you are a dev, to see something that “looks like” a data structure when you do {:?} in a formatted string, rather than a vector of bytes in the remaining 10% of situations where you want to debug the real messagepack bytes, call the .bytes() method on SerializedBytes and debug that.

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

Formats the value using the given formatter.

impl Default for SerializedBytes

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SerializedBytes

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SerializedBytes> for UnsafeBytes

fn from(sb: SerializedBytes) -> Self

Converts to this type from the input type.

impl From<UnsafeBytes> for SerializedBytes

fn from(b: UnsafeBytes) -> Self

Converts to this type from the input type.

impl Hash for SerializedBytes

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 Ord for SerializedBytes

fn cmp(&self, other: &SerializedBytes) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SerializedBytes

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for SerializedBytes

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&()> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: &()) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl<'a> TryFrom<&'a SerializedBytes> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(s: &'a SerializedBytes) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<()> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: ()) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<SerializedBytes> for ()

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(sb: SerializedBytes) -> Result<(), SerializedBytesError>

Performs the conversion.

impl Eq for SerializedBytes

impl StructuralPartialEq for SerializedBytes