Struct DeserializeShapeGraph 

pub struct DeserializeShapeGraph { /* private fields */ }

A complete deserialization shape graph rooted at one type.

Implementations

impl DeserializeShapeGraph

pub fn from_fn<F>(build_root: F) -> Self

where F: FnOnce(&mut DeserializeShapeContext) -> ShapeRef,

Builds a deserialization graph from a function that returns its root shape.

This lets a custom shape function describe a foreign root without introducing a wrapper type solely to implement DeserializeShape.

use serde_shape::DeserializeShapeContext;
use serde_shape::DeserializeShapeGraph;
use serde_shape::ShapeRef;

fn duration_input(_context: &mut DeserializeShapeContext) -> ShapeRef {
    ShapeRef::union([ShapeRef::String, ShapeRef::U64])
}

let graph = DeserializeShapeGraph::from_fn(duration_input);
assert_eq!(
    graph.root(),
    &ShapeRef::union([ShapeRef::String, ShapeRef::U64]),
);

pub fn for_type<T>() -> Self

where T: DeserializeShape + ?Sized,

Builds a complete deserialization shape graph rooted at T.

pub fn root(&self) -> &ShapeRef

Returns the root shape reference.

pub fn root_definition(&self) -> Option<&DeserializeDefinitionShape>

Returns the root definition when the graph root is a named type.

pub fn definitions(&self) -> &[DeserializeDefinitionShape]

Returns the named definitions reachable from the root.

pub fn definition(&self, id: ShapeId) -> Option<&DeserializeDefinitionShape>

Returns the definition at this id’s graph-local index.

A ShapeId does not encode graph ownership. The caller must pass an id produced by this graph; an id from another graph with an in-bounds index cannot be distinguished here.

pub fn definition_for( &self, shape: &ShapeRef, ) -> Option<&DeserializeDefinitionShape>

Returns the definition directly referenced by shape.

Returns None for non-definition shapes and out-of-bounds definition indexes.

Trait Implementations

impl Clone for DeserializeShapeGraph

fn clone(&self) -> DeserializeShapeGraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeserializeShapeGraph

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

Formats the value using the given formatter.

impl Eq for DeserializeShapeGraph

impl PartialEq for DeserializeShapeGraph

fn eq(&self, other: &DeserializeShapeGraph) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DeserializeShapeGraph