Struct TypePlan 

pub struct TypePlan<T: ?Sized> { /* private fields */ }

Precomputed deserialization plan tree for a type.

Built once from a Shape, this encodes all decisions needed during deserialization without repeated runtime lookups. The TypePlan owns all its allocations through internal arenas.

The type parameter T is phantom and provides compile-time type safety: you cannot accidentally pass a TypePlan<Foo> where TypePlan<Bar> is expected. There is no public way to erase the type parameter.

Implementations

impl<'facet, T: Facet<'facet> + ?Sized> TypePlan<T>

pub fn build() -> Result<Self, AllocError>

Build a TypePlan for type T.

The type parameter provides compile-time safety: you cannot accidentally pass a TypePlan<Foo> where TypePlan<Bar> is expected.

Note: TypePlan can be built for any Facet<'_> type because the SHAPE is always 'static. The lifetime parameter on Facet only affects the runtime deserialized values, not the type metadata.

Example

use facet_reflect::TypePlan;

let plan = TypePlan::<MyStruct>::build()?;

pub fn build_for_format( _format_namespace: Option<&'static str>, ) -> Result<Self, AllocError>

👎Deprecated since 0.44.0: format namespace no longer needed at build time; use build() instead

Build a TypePlan with format-specific proxy resolution.

Deprecated: Format namespace is no longer needed at build time. TypePlan now stores proxy nodes for all formats, and the format-specific proxy is selected at runtime during deserialization.

This method is kept for API compatibility but is equivalent to build().

pub fn core(&self) -> Arc<TypePlanCore>

Get a reference to the internal core.

pub fn root(&self) -> &TypePlanNode

Get the root node.

impl<'a, T: Facet<'a> + ?Sized> TypePlan<T>

pub fn partial<'facet>(&self) -> Result<Partial<'facet, true>, AllocError>

Create a borrowing Partial from this plan.

The Partial borrows from this TypePlan and can be used to deserialize values that may borrow from the input.

pub fn partial_owned(&self) -> Result<Partial<'static, false>, AllocError>

Create an owned Partial from this plan.

The Partial borrows from this TypePlan. The deserialized value will be fully owned (’static lifetime for borrowed data).

Trait Implementations

impl<T: Debug + ?Sized> Debug for TypePlan<T>

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

Formats the value using the given formatter.