DeserializeWithContext
Pair a context with a target type as a Serde DeserializeSeed.
Overview
In cgp-serde, a serialization library built with
Context-Generic Programming (CGP), DeserializeWithContext is the way to read with any
Serde format. Serde's Deserialize has no receiver, so there is nowhere to put a context, the
type whose wiring holds an application's choices. Serde's DeserializeSeed is the trait for
deserializing with state, and this adapter is a seed whose state is the context: driving it with a
format's deserializer reads the target type through the context's wiring.
Definition
pub struct DeserializeWithContext<'a, Context, Value> {
pub context: &'a Context,
pub phantom: PhantomData<Value>,
}
impl<'a, Context, Value> DeserializeWithContext<'a, Context, Value> {
pub fn new(context: &'a Context) -> Self { ... }
}
impl<'de, 'a, Context, Value> DeserializeSeed<'de> for DeserializeWithContext<'a, Context, Value>
where
Context: CanDeserializeValue<'de, Value>,
{ ... }
It lives in cgp_serde::types.
Usage
Serde's convenience functions such as serde_json::from_str accept only a Deserialize type, not a
seed, so build the format's deserializer, drive the seed with it, and check for trailing input:
let mut deserializer = serde_json::Deserializer::from_str(&text);
let value: Rec = DeserializeWithContext::new(&app).deserialize(&mut deserializer)?;
deserializer.end()?;
deserialize here is DeserializeSeed::deserialize, so serde::de::DeserializeSeed must be in
scope.
Behavior
Driving the seed calls the context's deserializer for Value and returns the value. Every nested
value goes back through the same wiring. The format's own error comes back unchanged. The adapter
needs no error wiring on the context.
Context dependencies
Context: CanDeserializeValue<'de, Value>.
Pairing
SerializeWithContext is the adapter for writing.
When to use it
Reach for DeserializeWithContext to read with a format that has no cgp-serde helper, or to
read JSON with no error wiring. For JSON in the context's own error type,
DeserializeFromJsonReader drives the seed and
checks for trailing input itself.
Related constructs
DeserializeRecordFieldsuses it for each field.
The ideas behind it
- The bridge to Serde: why reading needs a seed.
- Using a format: the seed with RON.
Source
An AI agent wrote this page using the CGP knowledge base. Its content was verified against the project's source. See How AI is used in this project.