Trait packs::structure::packable_struct::PackableStruct

pub trait PackableStruct: Sized {
    const FIELDS: usize;

    fn read_structure_body<T: Read>(reader: &mut T) -> Result<Self, DecodeError>;
    fn write_structure_body<T: Write>(
        &self, 
        writer: &mut T
    ) -> Result<usize, EncodeError>;
}

Denotes a struct which can be encoded and decoded using encode_struct and decode_struct.

Implementation

This trait can be derived using #[derive(PackableStruct)] if all fields implement Pack and Unpack and there are at most 15 fields. This is the recommend way of using this trait.

For a valid implementation in the context of PackStream, the limit of 15 fields must not be exceeded.

Associated Constants

const FIELDS: usize

Loading content...

Required methods

fn read_structure_body<T: Read>(reader: &mut T) -> Result<Self, DecodeError>

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

Loading content...

Implementors

impl PackableStruct for Date

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for DateTime

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for DateTimeZoneId

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for Duration

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for LocalDateTime

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for LocalTime

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for Node

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for Path

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for Point2D

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for Point3D

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for Relationship

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for Time

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

impl PackableStruct for UnboundRelationship

const FIELDS: usize

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

fn read_structure_body<T__PACKS_PROC_IMPL_PACKUNPACK: Read>(
    reader: &mut T__PACKS_PROC_IMPL_PACKUNPACK
) -> Result<Self, DecodeError>

Loading content...