Struct scale_encode::Composite

pub struct Composite<Vals>(pub Vals);

This type represents named or unnamed composite values, and can be used to help generate EncodeAsType impls. It’s primarily used by the exported macros to do just that.

use scale_encode::{ Error, EncodeAsType, Composite, PortableRegistry };

struct MyType {
   foo: bool,
   bar: u64,
   wibble: String
}

impl EncodeAsType for MyType {
    fn encode_as_type_to(&self, type_id: u32, types: &PortableRegistry, out: &mut Vec<u8>) -> Result<(), Error> {
        Composite([
            (Some("foo"), &self.foo as &dyn EncodeAsType),
            (Some("bar"), &self.bar as &dyn EncodeAsType),
            (Some("wibble"), &self.wibble as &dyn EncodeAsType)
        ].into_iter()).encode_as_type_to(type_id, types, out)
    }
}

Tuple Fields

0: Vals

Trait Implementations

impl<'a, Vals> EncodeAsFields for Composite<Vals>where Vals: ExactSizeIterator<Item = (Option<&'a str>, &'a dyn EncodeAsType)> + Clone,

fn encode_as_fields_to( &self, fields: &[PortableField], types: &PortableRegistry, out: &mut Vec<u8> ) -> Result<(), Error>

Given some fields describing the shape of a type, attempt to encode to that shape.

fn encode_as_fields( &self, fields: &[PortableField], types: &PortableRegistry ) -> Result<Vec<u8>, Error>

This is a helper function which internally calls EncodeAsFields::encode_as_fields_to. Prefer to implement that instead.

fn encode_as_field_ids_to( &self, field_ids: &[PortableFieldId], types: &PortableRegistry, out: &mut Vec<u8> ) -> Result<(), Error>

Given some field IDs describing the shape of a type, attempt to encode to that shape.

fn encode_as_field_ids( &self, field_ids: &[PortableFieldId], types: &PortableRegistry ) -> Result<Vec<u8>, Error>

This is a helper function which internally calls EncodeAsFields::encode_as_field_ids_to. Prefer to implement that instead.

impl<'a, Vals> EncodeAsType for Composite<Vals>where Vals: ExactSizeIterator<Item = (Option<&'a str>, &'a dyn EncodeAsType)> + Clone,

fn encode_as_type_to( &self, type_id: u32, types: &PortableRegistry, out: &mut Vec<u8> ) -> Result<(), Error>

Given some type_id, types, a context and some output target for the SCALE encoded bytes, attempt to SCALE encode the current value into the type given by type_id.

fn encode_as_type( &self, type_id: u32, types: &PortableRegistry ) -> Result<Vec<u8>, Error>

This is a helper function which internally calls EncodeAsType::encode_as_type_to. Prefer to implement that instead.