Trait Encodable 

pub trait Encodable {
    const FORMAT: Format;

    // Required method
    fn encode(
        &self,
        writer: &mut (impl WritesEncodable + ?Sized),
    ) -> Result<(), CodecError>;

    // Provided method
    fn encode_header(
        &self,
        writer: &mut (impl WritesEncodable + ?Sized),
    ) -> Result<(), CodecError> { ... }
}

A thing that encodes into codec-compliant data.

Required Associated Constants

const FORMAT: Format

This thing’s Format.

Required Methods

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

Encodes this thing’s data into writer without encoding a DataHeader.

In most cases, WritesEncodable::write_data should be used instead of calling this function directly.

let data = Text::from("cupcakes!");

// Encode data into a vector.
let mut encoded = vec![];
data.encode_header(&mut encoded).unwrap();
data.encode(&mut encoded).unwrap();
let mut encoded_slice = encoded.as_slice();

// Decode the header.
let mut decoded_header = DataHeader::default();
decoded_header.decode(&mut encoded_slice, None).unwrap();

// Decode the data.
let mut decoded_data = Text::default();
decoded_data.decode(&mut encoded_slice, Some(decoded_header)).unwrap();

assert_eq!(data, decoded_data);

Provided Methods

fn encode_header( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

Encodes this thing’s data header into writer.

If Self’s Encodable::FORMAT is not structured, this function should be a no-op.

Dyn Compatibility

This trait is not dyn compatible.

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

Implementations on Foreign Types

impl Encodable for [u8]

const FORMAT: Format

Encoded as a sequence of Format::Data, each containing a single u8 from the slice.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

fn encode_header( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for bool

const FORMAT: Format = u8::FORMAT

Encoded as a u8, with a value of 1 for true and 0 for false.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for f32

const FORMAT: Format

Encoded as a Format::Blob(4) containing the result of f32::to_le_bytes.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for f64

const FORMAT: Format

Encoded as a Format::Blob(8) containing the result of f64::to_le_bytes.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for i8

const FORMAT: Format

Encoded as a Format::Blob(1) containing the result of i8::to_le_bytes.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for i16

const FORMAT: Format

Encoded as a Format::Blob(2) containing the result of i16::to_le_bytes.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for i32

const FORMAT: Format

Encoded as a Format::Blob(4) containing the result of i32::to_le_bytes.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for i64

const FORMAT: Format

Encoded as a Format::Blob(8) containing the result of i64::to_le_bytes.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for u8

const FORMAT: Format

Encoded as a Format::Blob(1) containing the result of u8::to_le_bytes.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for u16

const FORMAT: Format

Encoded as a Format::Blob(2) containing the result of u16::to_le_bytes.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for u32

const FORMAT: Format

Encoded as a Format::Blob(4) containing the result of u32::to_le_bytes.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl Encodable for u64

const FORMAT: Format

Encoded as a Format::Blob(8) containing the result of u64::to_le_bytes.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl<K, V> Encodable for BTreeMap<K, V>

where K: Encodable + Ord + Clone + 'static, V: Encodable + Clone + 'static,

const FORMAT: Format

Maps are encoded as a sorted vector of keys followed by a sorted vector of corresponding values.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl<T> Encodable for Option<T>

where T: Default + Encodable + 'static,

const FORMAT: Format

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

fn encode_header( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl<T> Encodable for Vec<T>

where T: Encodable + 'static,

const FORMAT: Format

Encoded as a sequence of Format::Data, each containing a single T from the vector.

A Vec<u8> has the same encoding as a [u8].

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

fn encode_header( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

impl<const SIZE: usize> Encodable for [u8; SIZE]

const FORMAT: Format

Encoded as a Format::Data containing a Format::Blob(SIZE).

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

Implementors

impl Encodable for Coda

const FORMAT: Format

impl Encodable for CryptoCert

const FORMAT: Format

impl Encodable for DataField

const FORMAT: Format

impl Encodable for DataHeader

const FORMAT: Format

impl Encodable for DataType

const FORMAT: Format

impl Encodable for EncryptedData

const FORMAT: Format

impl Encodable for Format

const FORMAT: Format = Format::Fluid

impl Encodable for HashBytes

const FORMAT: Format = <[core::primitive::u8; 32]>::FORMAT

impl Encodable for PrivateKeyBytes

const FORMAT: Format = <[core::primitive::u8; 32]>::FORMAT

impl Encodable for PublicKeyBytes

const FORMAT: Format = <[core::primitive::u8; 32]>::FORMAT

impl Encodable for SignatureBytes

const FORMAT: Format = <[core::primitive::u8; 64]>::FORMAT

impl Encodable for Text

const FORMAT: Format = <[u8]>::FORMAT

impl Encodable for Type

const FORMAT: Format = Format::Fluid

impl Encodable for Unspecified

const FORMAT: Format = Format::Fluid