Struct vector_config::ser::Delegated

pub struct Delegated<I, H> { /* private fields */ }

Delegated serialization.

This adapter type lets us delegate the work of serializing an I by delegating it to H, where H represents some sort of helper type (a la serde_with) that takes I and serializes it in a specific way. This is a common pattern for using standard Rust types on the interior (such as std::time::Duration) but (de)serializing them in more friendly/ergonomic forms, like 10s, which requires the use of custom (de)serialize functions or types.

Concretely, in the codegen, if a value has no mitigating configuration, we treat it as if it is already Serialize, and use it directly. Otherwise, if specific attributes are in place that indicate the use of an optional helper type, we construct Delegated<I, H> where H is the value passed to #[serde(with = "...")].

Astute readers may realize: “but isn’t the value of with supposed to be a module path where a custom serialize and/or deserialize function exist?”, and they would be correct insofar as that is what the serde documentation states. However, that value is used to construct a path to a function to be called, which means that if you simply specify a type that is in scope, and it has a public function called serialize and/or deserialize, you end up with a path like MyCustomType::serialize, which is valid, and serde and serde_with use this fact to support generating custom types that can be used for (de)serialization.

This means we do some extra work up front to avoid misclassifying usages of #[serde(with = "...")] that are using module paths, and as such, this also means that those usages are not supported.

Trait Implementations

impl<I, H> Configurable for Delegated<I, H>

where H: Configurable,

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn validate_metadata(metadata: &Metadata) -> Result<(), GenerateError>

Validates the given metadata against this type.

fn generate_schema( gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl<I, H> From<I> for Delegated<I, As<H>>

where H: SerializeAs<I>,

fn from(input: I) -> Self

Converts to this type from the input type.

impl<I, H> Serialize for Delegated<I, As<H>>

where H: SerializeAs<I>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<I, H> ToValue for Delegated<I, H>

where H: Configurable, Delegated<I, H>: Serialize,

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.