Expand description
Exposed namespace of the module.
Modules§
- Exposed namespace of the module.
- Parented namespace of the module.
- Prelude to use essentials:
use my_module::prelude::*. - Protected namespace of the module.
Structs§
- A builder structure for constructing collections with a fluent and flexible interface.
- A wrapper around a closure to be used as a
FormingEnd. - Represents the formation definition for a hash map-like collection within the former framework.
- Holds the generic parameters for the
HashMapDefinition. - Represents the formation definition for a hash set-like collection within the former framework.
- Holds the generic parameters for the
HashSetDefinition. - A placeholder
FormingEndused when no end operation is required or applicable. - A
FormingEndimplementation that directly returns the formed collection as the final product of the forming process. - A
FormingEndimplementation that returns the storage itself as the formed entity, disregarding any contextual data. - Represents the formation definition for a vector-like collection within the former framework.
- Holds the generic parameters for the
VectorDefinition.
Traits§
- The
AssignWithTypetrait provides a mechanism to set a component on an object, utilizing the type information explicitly. This trait extends the functionality ofSetComponent by allowing implementers to specify the component’s type at the method call site, enhancing expressiveness in code that manipulates object states. - Represents a collection by defining the types of entries and values it handles.
- Provides functionality to add individual entries to a collection.
- Defines the capability to replace all entries in a collection with a new set of entries.
- Provides a mechanism for transforming a value back into a collection-specific entry format.
- Provides a generic interface for setting a component of a certain type on an object.
- Maps a type of entity to its corresponding former definition. This trait provides a linkage between the entity and its definition, allowing the formation logic to understand what definition to apply during the formation process.
- Provides a mapping between a type of entity and its associated formation type definitions.
- Maps a type of entity to its corresponding former. This trait binds an entity type to a specific former, facilitating the use of custom formers in complex formation scenarios.
- Maps a type of entity to its storage type. This trait defines what storage structure is used to hold the interim state of an entity during its formation.
- Facilitates the conversion of collection entries to their corresponding value representations.
- A trait for initiating a structured subforming process with contextual and intermediary storage linkage.
- Expands on
FormerDefinitionTypesby incorporating an ending mechanism for the formation process. This trait connects the formation types with a specific endpoint, defining how the formation process concludes, including any necessary transformations or validations. - Defines the fundamental components involved in the formation of an entity. This trait specifies the types of storage, the formed entity, and the context used during the formation process.
- Provides a mechanism for mutating the context and storage just before the forming process is completed.
- Defines a handler for the end of a subforming process, enabling the return of the original context.
- Provides an extension method for hash maps to facilitate the use of the builder pattern.
- Provides an extension method for
HashSetto facilitate the use of the builder pattern. - Defines the storage interface for entities being constructed using a forming pattern.
- Provides a mechanism to finalize the forming process by converting storage into its final formed state.
- Facilitates the conversion of values back into entries for specific collection types.
- Provides an extension method for vectors to facilitate the use of the builder pattern.
Type Aliases§
- Provides a streamlined builder interface for constructing hash map-like collections.
- Provides a concise alias for
CollectionFormerconfigured specifically forHashSet-like collections. - Provides a streamlined builder interface for constructing vector-like collections.
Derive Macros§
- Derives the
ComponentAssigntrait for struct fields, allowing each field to be set with a value that can be converted into the field’s type. - Macro to implement
Fromfor each component (field) of a structure. This macro simplifies the creation ofFromtrait implementations for struct fields, enabling easy conversion from a struct reference to its field types. - Derives the
ComponentsAssigntrait for a struct, enablingcomponents_assignwhich set all fields at once. - Derive macro for generating a
Formerstruct, applying a Builder Pattern to the annotated struct. - A procedural macro to automatically derive the
From<T>trait implementation for a struct, enabling instances of one type to be converted from instances of another type.