Struct AbiRemoved 

pub struct AbiRemoved<T, D = DefaultValueConstructor<T>>
where
    D: ValueConstructor<T>,
{ /* private fields */ }

Helper struct which represents a field which has been removed, for use with SavefileAbi - supporting both serialization and deserialization.

In contrast to Removed, this type supports both serialization and deserialization, and is preferred when SavefileAbi is to be used. Regular Savefile does not support serializing older versions, whereas SavefileAbi does.

Implementations

impl<T, D: ValueConstructor<T>> AbiRemoved<T, D>

pub fn new() -> AbiRemoved<T, D>

Helper to create an instance of AbiRemoved<T>. AbiRemoved<T> has no data.

Trait Implementations

impl<T: Clone, D> Clone for AbiRemoved<T, D>

where D: ValueConstructor<T> + Clone,

fn clone(&self) -> AbiRemoved<T, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, D> Debug for AbiRemoved<T, D>

where D: ValueConstructor<T> + Debug,

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

Formats the value using the given formatter.

impl<T: WithSchema + Deserialize, D: ValueConstructor<T>> Deserialize for AbiRemoved<T, D>

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

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

impl<T: Hash, D> Hash for AbiRemoved<T, D>

where D: ValueConstructor<T> + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Introspect, D: ValueConstructor<T>> Introspect for AbiRemoved<T, D>

fn introspect_value(&self) -> String

Returns the value of the object, excluding children, as a string. Exactly what the value returned here is depends on the type. For some types, like a plain array, there isn’t much of a value, the entire information of object resides in the children. For other cases, like a department in an organisation, it might make sense to have the value be the name, and have all the other properties as children.

fn introspect_child( &self, _index: usize, ) -> Option<Box<dyn IntrospectItem<'_> + '_>>

Returns an the name and &dyn Introspect for the child with the given index, or if no child with that index exists, None. All the children should be indexed consecutively starting at 0 with no gaps, all though there isn’t really anything stopping the user of the trait to have any arbitrary index strategy, consecutive numbering 0, 1, 2, … etc is strongly encouraged.

fn introspect_len(&self) -> usize

Returns the total number of children. The default implementation calculates this by simply calling introspect_child with higher and higher indexes until it returns None. It gives up if the count reaches 10000. If your type can be bigger and you want to be able to introspect it, override this method.

impl<T: Ord, D> Ord for AbiRemoved<T, D>

where D: ValueConstructor<T> + Ord,

fn cmp(&self, other: &AbiRemoved<T, D>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T, D: ValueConstructor<T>> Packed for AbiRemoved<T, D>

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<T: PartialEq, D> PartialEq for AbiRemoved<T, D>

where D: ValueConstructor<T> + PartialEq,

fn eq(&self, other: &AbiRemoved<T, D>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd, D> PartialOrd for AbiRemoved<T, D>

where D: ValueConstructor<T> + PartialOrd,

fn partial_cmp(&self, other: &AbiRemoved<T, D>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: WithSchema + Serialize + Default, D: ValueConstructor<T>> Serialize for AbiRemoved<T, D>

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

Serialize self into the given serializer.

impl<T: WithSchema, D: ValueConstructor<T>> WithSchema for AbiRemoved<T, D>

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<T: Copy, D> Copy for AbiRemoved<T, D>

where D: ValueConstructor<T> + Copy,

impl<T: Eq, D> Eq for AbiRemoved<T, D>

where D: ValueConstructor<T> + Eq,

impl<T, D: ValueConstructor<T>> Send for AbiRemoved<T, D>

Removed is a zero-sized type. It contains a PhantomData<*const T>, which means it doesn’t implement Send or Sync per default. However, implementing these is actually safe, so implement it manually.

impl<T, D> StructuralPartialEq for AbiRemoved<T, D>

where D: ValueConstructor<T>,

impl<T, D: ValueConstructor<T>> Sync for AbiRemoved<T, D>

Removed is a zero-sized type. It contains a PhantomData<*const T>, which means it doesn’t implement Send or Sync per default. However, implementing these is actually safe, so implement it manually.