Struct Removed

pub struct Removed<T> { /* private fields */ }

Helper struct which represents a field which has been removed.

In contrast to AbiRemoved, this type only supports deserialization. It is thus not recommended for use when SavefileAbi is to be used, and forward compatibility is desired.

The difference is that Removed does not require T to implement Default, or any other factory trait, since we never need to serialize dummy values of Removed (we never serialize using a schema where a field i Removed).

Implementations

impl<T> Removed<T>

pub fn new() -> Removed<T>

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

Trait Implementations

impl<T: Clone> Clone for Removed<T>

fn clone(&self) -> Removed<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Removed<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Removed<T>

fn default() -> Removed<T>

Returns the “default value” for a type.

impl<T: WithSchema + Deserialize> Deserialize for Removed<T>

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

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

impl<T: Hash> Hash for Removed<T>

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> Introspect for Removed<T>

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> Ord for Removed<T>

fn cmp(&self, other: &Removed<T>) -> 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> Packed for Removed<T>

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> PartialEq for Removed<T>

fn eq(&self, other: &Removed<T>) -> 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> PartialOrd for Removed<T>

fn partial_cmp(&self, other: &Removed<T>) -> 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 for Removed<T>

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

Serialize self into the given serializer.

impl<T: WithSchema> WithSchema for Removed<T>

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> Copy for Removed<T>

impl<T: Eq> Eq for Removed<T>

impl<T> Send for Removed<T>

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> StructuralPartialEq for Removed<T>

impl<T> Sync for Removed<T>

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.