Enum tezos_data_encoding::encoding::Encoding

pub enum Encoding {
    Unit,
    Int8,
    Uint8,
    Int16,
    Uint16,
    Int31,
    Int32,
    Uint32,
    Int64,
    RangedInt,
    Z,
    Mutez,
    Float,
    RangedFloat,
    Bool,
    String,
    BoundedString(usize),
    Bytes,
    Tags(usize, TagMap),
    List(Box<Encoding>),
    BoundedList(usize, Box<Encoding>),
    Enum,
    Option(Box<Encoding>),
    OptionalField(Box<Encoding>),
    Obj(&'static str, Schema),
    Tup(Vec<Encoding>),
    ShortDynamic(Box<Encoding>),
    Dynamic(Box<Encoding>),
    BoundedDynamic(usize, Box<Encoding>),
    Sized(usize, Box<Encoding>),
    Bounded(usize, Box<Encoding>),
    Greedy(Box<Encoding>),
    Hash(HashType),
    Timestamp,
    Custom,
}

Represents schema used for encoding a data into a json or a binary form.

Variants

Unit

Encoded as nothing in binary or null in json

Int8

Signed 8 bit integer (data is encoded as a byte in binary and an integer in JSON).

Uint8

Unsigned 8 bit integer (data is encoded as a byte in binary and an integer in JSON).

Int16

Signed 16 bit integer (data is encoded as a short in binary and an integer in JSON).

Uint16

Unsigned 16 bit integer (data is encoded as a short in binary and an integer in JSON).

Int31

Signed 31 bit integer, which corresponds to type int on 32-bit OCaml systems (data is encoded as a 32 bit int in binary and an integer in JSON).

Int32

Signed 32 bit integer (data is encoded as a 32-bit int in binary and an integer in JSON).

Uint32

Unsigned 32 bit integer (data is encoded as a 32-bit int in binary and an integer in JSON).

Int64

Signed 64 bit integer (data is encoded as a 64-bit int in binary and a decimal string in JSON).

RangedInt

Integer with bounds in a given range. Both bounds are inclusive.

Z

Big number In JSON, data is encoded as a decimal string. In binary, data is encoded as a variable length sequence of bytes, with a running unary size bit: the most significant bit of each byte tells is this is the last byte in the sequence (0) or if there is more to read (1). The second most significant bit of the first byte is reserved for the sign (positive if zero). Binary_size and sign bits ignored, data is then the binary representation of the absolute value of the number in little-endian order.

Mutez

Big number Almost identical to Encoding::Z, but does not contain the sign bit in the second most significant bit of the first byte

Float

Encoding of floating point number (encoded as a floating point number in JSON and a double in binary).

RangedFloat

Float with bounds in a given range. Both bounds are inclusive.

Bool

Encoding of a boolean (data is encoded as a byte in binary and a boolean in JSON).

String

Encoding of a string

• encoded as a byte sequence in binary prefixed by the length of the string
• encoded as a string in JSON.

BoundedString(usize)

Encoding of a string

• encoded as a byte sequence in binary prefixed by the length of the string
• encoded as a string in JSON.

Bytes

Encoding of arbitrary sized bytes (encoded via hex in JSON and directly as a sequence byte in binary).

Tags(usize, TagMap)

Tag is prefixed by tag id and followed by encoded bytes First argument represents size of the tag marker in bytes.

List(Box<Encoding>)

List combinator. It’s behavior is similar to Encoding::Greedy encoding. Main distinction is that we are expecting list of items instead of a single item to be contained in binary data.

• encoded as an array in JSON
• encoded as the concatenation of all the element in binary

BoundedList(usize, Box<Encoding>)

Encode enumeration via association list

• represented as a string in JSON and
• represented as an integer representing the element’s position in the list in binary. The integer size depends on the list size.

Enum

Encode enumeration via association list

• represented as a string in JSON and
• represented as an integer representing the element’s position in the list in binary. The integer size depends on the list size.

Option(Box<Encoding>)

Combinator to make an optional value (represented as a 1-byte tag followed by the data (or nothing) in binary and either the raw value or an empty object in JSON).

Compatible with ocaml usage: (req “arg” (Data_encoding.option string))

OptionalField(Box<Encoding>)

TE-172 - combinator to make an optional field, this is not the same as Encoding::Option (req “arg” (Data_encoding.option string)) is not the same as (opt “arg” string))

Compatible with ocaml usage: (opt “arg” string)

Obj(&'static str, Schema)

Is the collection of fields. not prefixed by anything in binary, encoded as the concatenation of all the element in binary

Tup(Vec<Encoding>)

Heterogeneous collection of values. Similar to Encoding::Obj, but schema can be any types, not just fields. Encoded as continuous binary representation.

ShortDynamic(Box<Encoding>)

Is the collection of fields. prefixed its length in bytes (1 Bytes), encoded as the concatenation of all the element in binary

Dynamic(Box<Encoding>)

Is the collection of fields. prefixed its length in bytes (4 Byte), encoded as the concatenation of all the element in binary

BoundedDynamic(usize, Box<Encoding>)

Is the collection of fields. prefixed its length in bytes (4 Bytes), encoded as the concatenation of all the element in binary

Sized(usize, Box<Encoding>)

Represents fixed size block in binary encoding.

Bounded(usize, Box<Encoding>)

Represents bounded block in binary encoding (one with a length that cannot exceed the upper value).

Greedy(Box<Encoding>)

Almost same as Encoding::Dynamic but without bytes size information prefix. It assumes that encoding passed as argument will process rest of the available data.

Hash(HashType)

Decode various types of hashes. Hash has it’s own predefined length and prefix. This is controller by a hash implementation.

Timestamp

Timestamp encoding.

• encoded as RFC 3339 in json
• encoded as Encoding::Int64 in binary

Custom

This is used to perform encoding using custom function rather than basing on schema. Used to get rid of recursion while encoding/decoding recursive types.

Implementations

impl Encoding

pub fn list(encoding: Encoding) -> Encoding

Utility function to construct Encoding::List without the need to manually create new Box.

pub fn bounded_list(max: usize, encoding: Encoding) -> Encoding

Utility function to construct Encoding::List without the need to manually create new Box.

pub fn sized(bytes_sz: usize, encoding: Encoding) -> Encoding

Utility function to construct Encoding::Sized without the need to manually create new Box.

pub fn bounded(max: usize, encoding: Encoding) -> Encoding

Utility function to construct Encoding::Sized without the need to manually create new Box.

pub fn greedy(encoding: Encoding) -> Encoding

Utility function to construct Encoding::Greedy without the need to manually create new Box.

pub fn short_dynamic(encoding: Encoding) -> Encoding

Utility function to construct Encoding::ShortDynamic without the need to manually create new Box.

pub fn dynamic(encoding: Encoding) -> Encoding

Utility function to construct Encoding::Dynamic without the need to manually create new Box.

pub fn bounded_dynamic(max: usize, encoding: Encoding) -> Encoding

Utility function to construct Encoding::Dynamic without the need to manually create new Box.

pub fn option(encoding: Encoding) -> Encoding

Utility function to construct Encoding::Option without the need to manually create new Box.

pub fn option_field(encoding: Encoding) -> Encoding

Utility function to construct Encoding::OptionalField without the need to manually create new Box.

Trait Implementations

impl Clone for Encoding

fn clone(&self) -> Encoding

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Encoding

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

Formats the value using the given formatter.