Skip to main content

Module aka

Module aka 

Source
Expand description

Include the alternative name manager. Also Known As (AKA) - an alternative name manager.

Aka lets a composite model expose stable public names while delegating the actual entity or port implementation to child components. Constructors named new_and_register_with_renames accept an Option<&Aka> and pass it to Entity::new_with_renames, port constructors such as InPort::new_with_renames and OutPort::new_with_renames, or child constructors so the tracking layer can record both the local implementation name and the parent-visible name.

The usual public constructor should remain new_and_register; it normally calls the rename-aware constructor with None so users do not need to know about Aka. Add a rename-aware constructor when a component delegates public ports to internal subcomponents, composes other rename-aware children, or needs alternate names for tracking, filtering, or monitor configuration. Leaf components whose local ports are already their public API can stay with new_and_register until a real composition use case appears.

Structs§

Aka
A structure to manage alternative names for entities

Functions§

get_alternative_names
Lookup the renames for a given port name
populate_aka
Build up a new set of alternative names with a new set of renames.
populate_aka_from_string
Build up a new set of alternative names with a new set of renames

Type Aliases§

AlternativeNames
Type alias for the optional list of alternative names