Crate facet_core

Expand description

Thanks to all individual and corporate sponsors, without whom this work could not exist:

Defines the core types and traits used throughout the facet ecosystem for runtime reflection:

Facet: exposes a SHAPE associated const
Shape: The central type that describes the memory layout and capabilities of a type
Various vtables that define how to manipulate types at runtime
The Def tree, which describes type definitions (structs, enums, etc.)

This crate is foundational to facet’s reflection capabilities, providing the type system that enables runtime type manipulation.

§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§

spez: Auto-deref specialization helpers for the Facet reflection system

Macros§

value_vtable: Creates a ValueVTable for a given type.
value_vtable_unsized: Similar to value_vtable! macro but for !Sized types.

Structs§

ArrayDef: Fields for array types
ArrayDefBuilder: Builder for ArrayDef
ArrayType: Describes a fixed-size array ([T; N])
ArrayVTable: Virtual table for an array
ArrayVTableBuilder: Builds a ArrayVTable
BoolAffinity: Definition for boolean scalar affinities
BoolAffinityBuilder: Builder for BoolAffinity
CharAffinity: Definition for character scalar affinities
CharAffinityBuilder: Builder for CharAffinity
ComplexNumberAffinity: Definition for string-like scalar affinities
ComplexNumberAffinityBuilder: Builder for ComplexNumberAffinity
ConstTypeId: TypeId equivalent usable in const contexts.
EmptyAffinity: Definition for empty scalar affinities
EmptyAffinityBuilder: Builder for EmptyAffinity
EnumDefBuilder: Builder for EnumDef
EnumType: Fields for enum types
Field: Describes a field in a struct or tuple
FieldBuilder: Builder for Field
FieldFlags: Flags that can be applied to fields to modify their behavior
FieldVTable: Vtable for field-specific operations
FieldVTableBuilder: Builder for FieldVTable
FunctionPointerDef: Common fields for function pointer types
FunctionPointerDefBuilder: Builder for FunctionPointerDef
HasherProxy: Provides an implementation of core::hash::Hasher for a given hasher pointer and write function
IpAddrAffinity: Definition for IP address scalar affinities
IpAddrAffinityBuilder: Builder for IpAddrAffinity
IterVTable: VTable for an iterator
IterVTableBuilder: Builds an IterVTable
ListDef: Fields for list types
ListDefBuilder: Builder for ListDef
ListVTable: Virtual table for a list-like type (like Vec<T>)
ListVTableBuilder: Builds a ListVTable
LockGuardVTable: Functions for manipulating a guard
LockResult: Type-erased result of locking a mutex-like smart pointer
MapDef: Fields for map types
MapDefBuilder: Builder for MapDef
MapVTable: Virtual table for a Map<K, V>
MapVTableBuilder: Builds a MapVTable
MarkerTraits: Bitflags for common marker traits that a type may implement
NumberAffinity: Definition for number-like scalar affinities
NumberAffinityBuilder: Builder for NumberAffinity
Opaque: Helper type for opaque members
OpaqueAffinity: Definition for opaque scalar affinities
OpaqueAffinityBuilder: Builder for OpaqueAffinity
OptionDef: Describes an Option — including a vtable to query and alter its state, and the inner shape (the T in Option<T>).
OptionDefBuilder: Builder for OptionDef
OptionVTable: Virtual table for Option<T>
OptionVTableBuilder: Builds an OptionVTable
OtherAffinity: Definition for other scalar affinities
OtherAffinityBuilder: Builder for OtherAffinity
PathAffinity: Definition for path scalar affinities
PathAffinityBuilder: Builder for PathAffinity
PtrConst: A type-erased read-only pointer to an initialized value.
PtrMut: A type-erased pointer to an initialized value
PtrUninit: A type-erased pointer to an uninitialized value
Repr: Describes base representation of the type
ScalarDef: Definition for scalar types
ScalarDefBuilder: Builder for ScalarDef
SetDef: Fields for set types
SetDefBuilder: Builder for SetDef
SetVTable: Virtual table for a Set<T>
SetVTableBuilder: Builds a SetVTable
Shape: Schema for reflection of a type
ShapeBuilder: Builder for Shape
SliceDef: Fields for slice types
SliceDefBuilder: Builder for SliceDef
SliceType: Describes a slice ([T])
SliceVTable: Virtual table for a slice-like type (like Vec<T>, but also HashSet<T>, etc.)
SliceVTableBuilder: Builds a SliceVTable
SmartPointerDef: Describes a smart pointer — including a vtable to query and alter its state, and the inner shape (the pointee type in the smart pointer).
SmartPointerDefBuilder: Builder for creating a SmartPointerDef.
SmartPointerFlags: Flags to represent various characteristics of smart pointers
SmartPointerVTable: Functions for interacting with a smart pointer
SmartPointerVTableBuilder: Builder for creating a SmartPointerVTable.
SocketAddrAffinity: Definition for socket address scalar affinities
SocketAddrAffinityBuilder: Builder for SocketAddrAffinity
StringAffinity: Definition for string-like scalar affinities
StringAffinityBuilder: Builder for StringAffinity
StructBuilder: Builder for StructType
StructType: Common fields for struct-like types
TimeAffinity: Definition for Datetime/Timestamp scalar affinities
TimeAffinityBuilder: Builder for UuidAffinity
TypeNameOpts: Options for formatting the name of a type
TypeParam: Represents a lifetime parameter, e.g., 'a or 'a: 'b + 'c.
TypedPtrUninit: A pointer to an uninitialized value with a lifetime.
UlidAffinity: Definition for ULID and ULID-like scalar affinities
UlidAffinityBuilder: Builder for UlidAffinity
UnionType: Common fields for union types
UnsizedError: Tried to get the Layout of an unsized type
UrlAffinity: Definition for URL scalar affinities
UrlAffinityBuilder: Builder for UrlAffinity
UuidAffinity: Definition for UUID and UUID-like scalar affinities
UuidAffinityBuilder: Builder for UuidAffinity
VTableView: A typed view of a ValueVTable.
ValuePointerType: Describes the raw/reference pointer
ValueVTable: VTable for common operations that can be performed on any shape
ValueVTableBuilder: Builds a ValueVTable
ValueVTableBuilderUnsized: Builds a ValueVTable for a !Sized type
Variant: Describes a variant of an enum
VariantBuilder: Builder for Variant

Enums§

BaseRepr: Underlying byte layout representation
Characteristic: A characteristic a shape can have
Def: The semantic definition of a shape: is it more like a scalar, a map, a list?
EnumRepr: All possible representations for Rust enums — ie. the type/size of the discriminant
FieldAttribute: An attribute that can be set on a field
FieldError: Errors encountered when calling field_by_index or field_by_name
FunctionAbi: The calling ABI of a function pointer
IntegerSize: Size specification for integer types
KnownSmartPointer: Represents common standard library smart pointer kinds
NumberBits: Bit representation of numbers
NumericType: Describes numeric types (integer/float)
ParseError: Error returned by ParseFn
PointerType: Describes all pointer types
PrimitiveType: Describes built-in primitives (u32, bool, str, etc.)
ScalarAffinity: Scalar affinity: what a scalar spiritually is: a number, a string, a bool, something else entirely?
SequenceType: Describes built-in sequence type (array, slice)
ShapeAttribute: An attribute that can be applied to a shape
ShapeLayout: Layout of the shape
Signedness: Represents whether a numeric type is signed or unsigned
StructKind: Describes the kind of struct (useful for deserializing)
TextualType: Describes textual types (char/string)
TryBorrowInnerError: Error type returned by TryBorrowInnerFn when attempting to borrow the inner value from a wrapper type.
TryFromError: Error type for TryFrom conversion failures
TryIntoInnerError: Error type returned by TryIntoInnerFn when attempting to extract the inner value from a wrapper type.
Type: The definition of a shape in accordance to rust reference:
UserType: User-defined types (structs, enums, unions)
VariantAttribute: An attribute that can be set on an enum variant

Traits§

Facet: Allows querying the Shape of a type, which in turn lets us inspect any fields, build a value of this type progressively, etc.
IterItem: A kind of item that an IterVTable returns

Functions§

of: Create a TypeId for a type.

Type Aliases§

ArrayAsMutPtrFn: Get mutable pointer to the data buffer of the array.
ArrayAsPtrFn: Get pointer to the data buffer of the array.
BorrowFn: Tries to obtain a reference to the inner value of the smart pointer.
CloneIntoFn: Function to clone a value into another already-allocated value
CloneIntoFnTyped: Function to clone a value into another already-allocated value
CmpFn: Function to compare two values and return their ordering
CmpFnTyped: Function to compare two values and return their ordering
DebugFn: Function to format a value for debug. If this returns None, the shape did not implement Debug.
DebugFnTyped: Function to format a value for debug. If this returns None, the shape did not implement Debug.
DefaultInPlaceFn: Function to set a value to its default in-place
DefaultInPlaceFnTyped: Function to set a value to its default in-place
DisplayFn: Function to format a value for display
DisplayFnTyped: Function to format a value for display
DowngradeIntoFn: Downgrades a strong pointer to a weak one.
DropInPlaceFn: Function to drop a value
HashFn: Function to hash a value
HashFnTyped: Function to hash a value
HasherWriteFn: Function to write bytes to a hasher
HasherWriteFnTyped: Function to write bytes to a hasher
InvariantsFn: Function to validate the invariants of a value. If it returns false, the value is considered invalid.
InvariantsFnTyped: Function to validate the invariants of a value. If it returns false, the value is considered invalid.
IterDeallocFn: Deallocate the iterator
IterInitWithValueFn: Create a new iterator that iterates over the provided value
IterNextBackFn: Advance the iterator in reverse, returning the next value from the end of the iterator.
IterNextFn: Advance the iterator, returning the next value from the iterator
IterSizeHintFn: Return the lower and upper bounds of the iterator, if known.
ListAsMutPtrFn: Get mutable pointer to the data buffer of the list.
ListAsPtrFn: Get pointer to the data buffer of the list.
ListGetFn: Get pointer to the element at index in the list, or None if the index is out of bounds.
ListGetMutFn: Get mutable pointer to the element at index in the list, or None if the index is out of bounds.
ListInitInPlaceWithCapacityFn: Initialize a list in place with a given capacity
ListLenFn: Get the number of items in the list
ListPushFn: Push an item to the list
LockFn: Acquires a lock on a mutex-like smart pointer
MapContainsKeyFn: Check if the map contains a key
MapGetValuePtrFn: Get pointer to a value for a given key, returns None if not found
MapInitInPlaceWithCapacityFn: Initialize a map in place with a given capacity
MapInsertFn: Insert a key-value pair into the map
MapLenFn: Get the number of entries in the map
NewIntoFn: Creates a new smart pointer wrapping the given value.
OptionGetValueFn: Get the value contained in an option, if present
OptionInitNoneFn: Initialize an option with None
OptionInitSomeFn: Initialize an option with Some(value)
OptionIsSomeFn: Check if an option contains a value
OptionReplaceWithFn: Replace an existing option with a new value
ParseFn: Function to parse a value from a string.
ParseFnTyped: Function to parse a value from a string.
PartialEqFn: Function to check if two values are partially equal
PartialEqFnTyped: Function to check if two values are partially equal
PartialOrdFn: Function to compare two values and return their ordering if comparable
PartialOrdFnTyped: Function to compare two values and return their ordering if comparable
ReadFn: Acquires a read lock on a reader-writer lock-like smart pointer
SetContainsFn: Check if the set contains a value
SetInitInPlaceWithCapacityFn: Initialize a set in place with a given capacity
SetInsertFn: Insert a value in the set if not already contained, returning true if the value wasn’t present before
SetLenFn: Get the number of values in the set
SkipSerializingIfFn: A function that, if present, determines whether field should be included in the serialization step.
SliceAsMutPtrFn: Get mutable pointer to the data buffer of the slice
SliceAsPtrFn: Get pointer to the data buffer of the slice
SliceLenFn: Get the number of items in the slice
TryBorrowInnerFn: Function to borrow the inner value from a transparent/newtype wrapper without copying.
TryBorrowInnerFnTyped: Function to borrow the inner value from a transparent/newtype wrapper without copying.
TryFromFn: Function to try converting from another type
TryFromFnTyped: Function to try converting from another type
TryIntoInnerFn: Function to convert a transparent/newtype wrapper into its inner type.
TryIntoInnerFnTyped: Function to convert a transparent/newtype wrapper into its inner type.
TypeNameFn: A function that formats the name of a type.
UpgradeIntoFn: Tries to upgrade the weak pointer to a strong one.
WriteFn: Acquires a write lock on a reader-writer lock-like smart pointer

Crate facet_coreCopy item path