Enum relay_protocol::SkipSerialization

pub enum SkipSerialization {
    Never,
    Null(bool),
    Empty(bool),
}

Defines behavior for skipping the serialization of fields.

This behavior is configured via the skip_serialization attribute on fields of structs. It is passed as parameter to ToValue::skip_serialization of the corresponding field.

The default for fields in derived structs is SkipSerialization::Null(true), which will skips null values under the field recursively. Newtype structs (MyType(T)) and enums pass through to their inner type and variant, respectively.

Example

#[derive(Debug, Empty, ToValue)]
struct Helper {
    #[metastructure(skip_serialization = "never")]
    items: Annotated<Array<String>>,
}

Variants

Never

Serialize all values. Missing values will be serialized as null.

Null(bool)

Do not serialize null values but keep empty collections.

If the bool flag is set to true, this applies to all descendants recursively; if it is set to false, this only applies to direct children and does not propagate down.

Empty(bool)

Do not serialize empty objects as indicated by the Empty trait.

If the bool flag is set to true, this applies to all descendants recursively; if it is set to false, this only applies to direct children and does not propagate down.

Implementations

impl SkipSerialization

pub fn descend(self) -> Self

Returns the serialization behavior for child elements.

Shallow behaviors - Null(false) and Empty(false) - propagate as Never, all others remain the same. This allows empty containers to be skipped while their contents will serialize with null values.

Trait Implementations

impl Clone for SkipSerialization

fn clone(&self) -> SkipSerialization

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SkipSerialization

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

Formats the value using the given formatter.

impl Default for SkipSerialization

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SkipSerialization

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

impl Eq for SkipSerialization

impl StructuralPartialEq for SkipSerialization