Struct savefile::Field

pub struct Field {
    pub name: String,
    pub value: Box<Schema>,
    /* private fields */
}

A field is serialized according to its value. The name is just for diagnostics.

Fields

name: String

Field name

value: Box<Schema>

Field type

Implementations

impl Field

pub fn new(name: String, value: Box<Schema>) -> Field

Create a new instance of field, with the given name and type

pub unsafe fn unsafe_new( name: String, value: Box<Schema>, offset: Option<usize> ) -> Field

Create a new instance of field, with the given name and type. The offset is the offset of the field within its struct.

Safety

The offset must be the correct offset of the field within its struct.

pub fn layout_compatible(&self, other: &Field) -> bool

Determine if the two fields are laid out identically in memory, in their parent objects.

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Deserialize for Field

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

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

impl Packed for Field

unsafe fn repr_c_optimization_safe(_version: u32) -> IsPacked

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 memory layout of the given protocol version. Note, the only memory layout existing is that of the most recent version, so Packed-optimization only works when disk-format is identical to memory version.

impl PartialEq for Field

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

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 Field

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

Returns a representation of the schema used by this Serialize implementation for the given version. The WithSchemaContext can be used to guard against recursive data structures. See documentation of WithSchemaContext.

impl StructuralPartialEq for Field