Struct scale_bits::scale::format::Format

pub struct Format {
    pub store: StoreFormat,
    pub order: OrderFormat,
}

A description of the format used to SCALE encode some bits.

Fields

store: StoreFormat

The StoreFormat defines the size of each chunk that’s written (eg u8, u16 etc).

order: OrderFormat

The OrderFormat determines the order in which we write bits to the store type; do we write to the least significant bit first and work up, or write to the most significant byte first and work down.

Implementations

impl Format

pub fn new(store: StoreFormat, order: OrderFormat) -> Self

Define a new format by providing a store and order.

Example

use scale_bits::scale::format::{ Format, StoreFormat, OrderFormat };

let format = Format::new(StoreFormat::U8, OrderFormat::Lsb0);

pub fn from_metadata(
    ty: &TypeDefBitSequence<PortableForm>,
    types: &PortableRegistry
) -> Result<Format, FromMetadataError>

Use metadata to obtain details about the format.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl PartialEq<Format> for Format

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

impl Eq for Format

impl StructuralEq for Format

impl StructuralPartialEq for Format