Expand description
§facet-reflect
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.
§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.
Macros§
- debug
- Forwards to log::debug when the log feature is enabled
- trace
- Forwards to log::trace when the log feature is enabled
Structs§
- Field
Iter - An iterator over all the fields of a struct or enum. See
HasFields::fields - Fields
ForSerialize Iter - 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.
- Heap
Value - A type-erased value stored on the heap
- Partial
- A type-erased, heap-allocated, partially-initialized value.
- Peek
- Lets you read from a value (implements read-only
ValueVTableproxies) - Peek
Enum - Lets you read from an enum (implements read-only enum operations)
- Peek
List - Lets you read from a list (implements read-only
facet_core::ListVTableproxies) - Peek
List Iter - Iterator over a
PeekList - Peek
List Like - Lets you read from a list, array or slice
- Peek
List Like Iter - Iterator over a
PeekListLike - PeekMap
- Lets you read from a map (implements read-only
facet_core::MapVTableproxies) - Peek
MapIter - Iterator over key-value pairs in a
PeekMap - Peek
Option - Lets you read from an option (implements read-only option operations)
- Peek
Pointer - Represents a pointer that can be peeked at during memory inspection.
- PeekSet
- Lets you read from a set
- Peek
SetIter - Iterator over values in a
PeekSet - Peek
Struct - Lets you read from a struct (implements read-only struct operations)
- Peek
Tuple - Lets you read from a tuple
- Tuple
Type - Local representation of a tuple type for peek operations
- Typed
Partial - A typed wrapper around
Partial, for when you want to statically ensure thatbuildgives you the proper type. - ValueId
- A unique identifier for a peek value
Enums§
- List
Like Def - Fields for types which act like lists
- Reflect
Error - Errors that can occur when reflecting on types.
- Scalar
Type - All scalar types supported out of the box by peek and poke.
- Tracker
Kind - A kind-only version of Tracker
- Variant
Error - Error that can occur when trying to determine variant information
Traits§
- HasFields
- Trait for types that have field methods
Functions§
- 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§
- Tuple
Field - Field index and associated peek value