Struct packs::structure::generic_struct::GenericStruct

pub struct GenericStruct {
    pub tag_byte: u8,
    pub fields: Vec<Value<()>>,
}

An anonymous, generic variant for structure values. It does denote different structures by a tag_byte field; all fields are written and read as Value in the order in which they were given. This allows for parsing of any structure which is validly encoded, valid in the PackStream specification sense, i.e. the struct marker and the field size, a tag byte denoting the struct type and then a list of the fields.

It does not allow for recursive patterns; in a struct there is no other structure allowed.

Encode and Decode

Encoding and Decoding is given by the generic Pack and Unpack implementation for Value<S> where S: PackableStructSum:

let s = GenericStruct {
        tag_byte: 0x01,
        fields: vec!(Value::Float(42.0), Value::String(String::from("hello world"))),
};

let value = Value::Structure(s);

let mut buffer = Vec::new();
value.encode(&mut buffer).unwrap();

let res = <Value<GenericStruct>>::decode(&mut buffer.as_slice()).unwrap();

assert_eq!(res, value);

Fields

tag_byte: u8

fields: Vec<Value<()>>

Trait Implementations

impl Clone for GenericStruct

fn clone(&self) -> GenericStruct

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenericStruct

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

Formats the value using the given formatter.

impl PackableStructSum for GenericStruct

fn read_struct_body<T: Read>(
    size: usize,
    tag_byte: u8,
    reader: &mut T
) -> Result<Self, DecodeError>

fn write_struct_body<T: Write>(
    &self,
    writer: &mut T
) -> Result<usize, EncodeError>

fn fields_len(&self) -> usize

fn tag_byte(&self) -> u8

impl PartialEq<GenericStruct> for GenericStruct

fn eq(&self, other: &GenericStruct) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GenericStruct) -> bool

This method tests for !=.

impl StructuralPartialEq for GenericStruct