Enum savefile::Schema

pub enum Schema {
    Struct(SchemaStruct),
    Enum(SchemaEnum),
    Primitive(SchemaPrimitive),
    Vector(Box<Schema>),
    Array(SchemaArray),
    SchemaOption(Box<Schema>),
    Undefined,
    ZeroSize,
    Custom(String),
}

The schema represents the save file format of your data structure. It is an AST (Abstract Syntax Tree) for consisting of various types of nodes in the savefile format. Custom Serialize-implementations cannot add new types to this tree, but must reuse these existing ones. See the various enum variants for more information:

Variants

Struct(SchemaStruct)

Represents a struct. Custom implementations of Serialize may use this format are encouraged to use this format.

Enum(SchemaEnum)

Represents an enum

Primitive(SchemaPrimitive)

Represents a primitive: Any of the various integer types (u8, i8, u16, i16 etc…), or String

Vector(Box<Schema>)

A Vector of arbitrary nodes, all of the given type

Array(SchemaArray)

An array of N arbitrary nodes, all of the given type

SchemaOption(Box<Schema>)

An Option variable instance of the given type.

Undefined

Basically a dummy value, the Schema nodes themselves report this schema if queried.

ZeroSize

A zero-sized type. I.e, there is no data to serialize or deserialize.

Custom(String)

A user-defined, custom type. The string can be anything. The schema only matches if the string is identical

Implementations

impl Schema

pub fn new_tuple1<T1: WithSchema>(version: u32) -> Schema

Create a 1-element tuple

pub fn new_tuple2<T1: WithSchema, T2: WithSchema>(version: u32) -> Schema

Create a 2-element tuple

pub fn new_tuple3<T1: WithSchema, T2: WithSchema, T3: WithSchema>( version: u32 ) -> Schema

Create a 3-element tuple

pub fn new_tuple4<T1: WithSchema, T2: WithSchema, T3: WithSchema, T4: WithSchema>( version: u32 ) -> Schema

Create a 4-element tuple

pub fn serialized_size(&self) -> Option<usize>

Size

Trait Implementations

impl Debug for Schema

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

Formats the value using the given formatter.

impl Deserialize for Schema

fn deserialize( deserializer: &mut Deserializer<'_, impl Read> ) -> Result<Self, SavefileError>

Deserialize and return an instance of Self from the given deserializer.

impl PartialEq for Schema

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

unsafe fn repr_c_optimization_safe(_version: u32) -> IsReprC

This method returns true if the optimization is allowed for the protocol version given as an argument. This may return true if and only if the given protocol version has a serialized format identical to the given protocol version.

impl Serialize for Schema

fn serialize( &self, serializer: &mut Serializer<'_, impl Write> ) -> Result<(), SavefileError>

Serialize self into the given serializer. In versions prior to 0.15, ‘Serializer’ did not accept a type parameter. It now requires a type parameter with the type of writer expected.

impl WithSchema for Schema

fn schema(_version: u32) -> Schema

Returns a representation of the schema used by this Serialize implementation for the given version.

impl StructuralPartialEq for Schema