Crate facet_reflect

Expand description

Whereas the core facet crate provides essential traits like Facet itself, and data structures like Type, StructType, Field, etc., facet-reflect uses that information about the shape of types to allow:

Read-only access to already-initialized values (via Peek)
Construction of values from scratch (via Partial)

This allows, respectively, serialization and deserialization, without risking breaking invariants in types that implement Facet.

§LLM contribution policy

§Sponsors

Thanks to all individual sponsors:

…along with corporate sponsors:

…without whom this work could not exist.

§Special thanks

The facet logo was drawn by Misiasart.

§License

Licensed under either of:

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Modules§

deferred_materialization: Deferred Materialization

Macros§

debug: Forwards to log::debug when the log feature is enabled
trace: Forwards to log::trace when the log feature is enabled

Structs§

CovariantPeek: A covariant wrapper around Peek for types that are covariant over their lifetime parameter.
DuplicateFieldError: Error when building a resolution.
FieldInfo: Information about a single field in a resolution.
FieldItem: A field item with runtime state for serialization.
FieldIter: An iterator over all the fields of a struct or enum. See HasFields::fields
FieldPath: A path through the type tree to a field.
FieldsForSerializeIter: An iterator over the fields of a struct or enum that should be serialized. See HasFields::fields_for_serialize
Guard: A guard structure to manage memory allocation and deallocation.
HeapValue: A type-erased value stored on the heap
OwnedPeek: An Owned version of a Peek used for custom serialization
Partial: A type-erased, heap-allocated, partially-initialized value.
Peek: A read-only view into a value with runtime type information.
PeekDynamicValue: Lets you read from a dynamic value (implements read-only operations for DynamicValue types)
PeekDynamicValueArrayIter: Iterator over array elements in a dynamic value
PeekDynamicValueObjectIter: Iterator over object entries in a dynamic value
PeekEnum: Lets you read from an enum (implements read-only enum operations)
PeekList: Lets you read from a list (implements read-only facet_core::ListVTable proxies)
PeekListIter: Iterator over a PeekList
PeekListLike: Lets you read from a list, array or slice
PeekListLikeIter: Iterator over a PeekListLike
PeekMap: Lets you read from a map (implements read-only facet_core::MapVTable proxies)
PeekMapIter: Iterator over key-value pairs in a PeekMap
PeekNdArray: Lets you read from an n-dimensional array (implements read-only facet_core::NdArrayVTable proxies)
PeekOption: Lets you read from an option (implements read-only option operations)
PeekPointer: Represents a pointer that can be peeked at during memory inspection.
PeekResult: Lets you read from a result (implements read-only result operations)
PeekSet: Lets you read from a set
PeekSetIter: Iterator over values in a PeekSet
PeekStruct: Lets you read from a struct (implements read-only struct operations)
PeekTuple: Lets you read from a tuple
Poke: A mutable view into a value with runtime type information.
PokeEnum: Lets you mutate an enum’s fields.
PokeStruct: Lets you mutate a struct’s fields.
Resolution: One possible “shape” the flattened type could take.
Span: Source span with offset and length.
Spanned: A value with source span information.
TupleType: Local representation of a tuple type for peek operations
ValueId: A unique identifier for a peek value
VariantSelection: Records that a specific enum field has a specific variant selected.

Enums§

ListLikeDef: Fields for types which act like lists
MatchResult: Result of matching input fields against a resolution.
PathSegment: A segment in a field path.
ReflectError: Errors that can occur when reflecting on types.
ScalarType: All scalar types supported out of the box by facet.
StrideError: Error that can occur when trying to access an n-dimensional array as strided
TrackerKind: A kind-only version of Tracker
VariantError: Error that can occur when trying to determine variant information

Traits§

HasFields: Trait for types that have field methods

Functions§

find_span_metadata_field: Find the span metadata field in a struct shape.
get_spanned_inner_shape: Extract the inner value shape from a Spanned-like struct.
is_spanned_shape: Check if a shape represents a type with span metadata (like Spanned<T>).
peek_enum: Returns the enum definition if the shape represents an enum, None otherwise
peek_enum_repr: Returns the enum representation if the shape represents an enum, None otherwise
peek_enum_variants: Returns the enum variants if the shape represents an enum, None otherwise

Type Aliases§

KeyPath: A path of serialized key names for probing. Unlike FieldPath which tracks the internal type structure (including variant selections), KeyPath only tracks the keys as they appear in the serialized format.
TupleField: Field index and associated peek value