pub struct EntityDescriptor {
pub type_name: &'static str,
pub type_id: TypeId,
pub logical_id: Option<EntityClassId>,
pub solution_field: &'static str,
pub is_collection: bool,
pub variable_descriptors: Vec<VariableDescriptor>,
pub extractor: Option<Box<dyn EntityExtractor>>,
pub id_field: Option<&'static str>,
pub pin_field: Option<&'static str>,
/* private fields */
}Expand description
Describes a planning entity type at runtime.
Fields§
§type_name: &'static strName of the entity type.
type_id: TypeIdTypeId of the entity type.
logical_id: Option<EntityClassId>Logical entity class ID for dynamic binding models.
solution_field: &'static strField name in the solution (for entity collections).
is_collection: boolWhether this is a collection of entities.
variable_descriptors: Vec<VariableDescriptor>Variable descriptors for this entity (metadata only).
extractor: Option<Box<dyn EntityExtractor>>Extractor for getting entities from a solution.
id_field: Option<&'static str>The ID field name, if any.
pin_field: Option<&'static str>The pinning field name, if any.
Implementations§
Source§impl EntityDescriptor
impl EntityDescriptor
Sourcepub fn new(
type_name: &'static str,
type_id: TypeId,
solution_field: &'static str,
) -> Self
pub fn new( type_name: &'static str, type_id: TypeId, solution_field: &'static str, ) -> Self
Creates a descriptor for a collection field solution_field holding
entities of type type_name, with no variables, extractor, ID or
pinning.
Sourcepub fn with_extractor(self, extractor: Box<dyn EntityExtractor>) -> Self
pub fn with_extractor(self, extractor: Box<dyn EntityExtractor>) -> Self
Sets the extractor used to read entities out of a solution.
Sourcepub fn with_logical_id(self, logical_id: EntityClassId) -> Self
pub fn with_logical_id(self, logical_id: EntityClassId) -> Self
Sets the logical entity class ID used by dynamic bindings.
Sourcepub fn with_variable(self, descriptor: VariableDescriptor) -> Self
pub fn with_variable(self, descriptor: VariableDescriptor) -> Self
Appends a variable descriptor.
Sourcepub fn with_id_field(self, field: &'static str) -> Self
pub fn with_id_field(self, field: &'static str) -> Self
Names the entity’s planning ID field.
Sourcepub fn with_pin_field(self, field: &'static str) -> Self
pub fn with_pin_field(self, field: &'static str) -> Self
Names the entity’s pinning field.
Sourcepub fn with_pin_predicate(self, predicate: fn(&dyn Any) -> bool) -> Self
pub fn with_pin_predicate(self, predicate: fn(&dyn Any) -> bool) -> Self
Supplies the entity-level pin predicate for a manually assembled descriptor.
Sourcepub fn is_pinned(&self, solution: &dyn Any, index: usize) -> bool
pub fn is_pinned(&self, solution: &dyn Any, index: usize) -> bool
Returns whether this entity is pinned. Descriptors without a predicate are unrestricted.
Sourcepub fn has_pin_predicate(&self) -> bool
pub fn has_pin_predicate(&self) -> bool
Returns true when a pin predicate is configured.
Sourcepub fn genuine_variable_descriptors(
&self,
) -> impl Iterator<Item = &VariableDescriptor>
pub fn genuine_variable_descriptors( &self, ) -> impl Iterator<Item = &VariableDescriptor>
Iterates over the genuine (scalar and list) variables.
Sourcepub fn shadow_variable_descriptors(
&self,
) -> impl Iterator<Item = &VariableDescriptor>
pub fn shadow_variable_descriptors( &self, ) -> impl Iterator<Item = &VariableDescriptor>
Iterates over the shadow variables.
Sourcepub fn find_variable(&self, name: &str) -> Option<&VariableDescriptor>
pub fn find_variable(&self, name: &str) -> Option<&VariableDescriptor>
Finds a variable by field name.
Sourcepub fn has_genuine_variables(&self) -> bool
pub fn has_genuine_variables(&self) -> bool
Returns true when the entity declares at least one genuine variable.
Sourcepub fn has_extractor(&self) -> bool
pub fn has_extractor(&self) -> bool
Returns true when an extractor is configured.
Sourcepub fn entity_count(&self, solution: &dyn Any) -> Option<usize>
pub fn entity_count(&self, solution: &dyn Any) -> Option<usize>
Number of entities of this type in solution; None without an
extractor or when solution is not the expected type.
Sourcepub fn get_entity<'a>(
&self,
solution: &'a dyn Any,
index: usize,
) -> Option<&'a dyn Any>
pub fn get_entity<'a>( &self, solution: &'a dyn Any, index: usize, ) -> Option<&'a dyn Any>
Borrows the entity at index; None without an extractor, on a
solution type mismatch, or when index is out of range.
Sourcepub fn get_entity_mut<'a>(
&self,
solution: &'a mut dyn Any,
index: usize,
) -> Option<&'a mut dyn Any>
pub fn get_entity_mut<'a>( &self, solution: &'a mut dyn Any, index: usize, ) -> Option<&'a mut dyn Any>
Mutably borrows the entity at index; None without an extractor, on a
solution type mismatch, or when index is out of range.
Sourcepub fn entity_refs(&self, solution: &dyn Any) -> Vec<EntityRef>
pub fn entity_refs(&self, solution: &dyn Any) -> Vec<EntityRef>
References to every entity of this type in solution; empty without an
extractor or on a solution type mismatch.
Sourcepub fn for_each_entity<F>(&self, solution: &dyn Any, f: F) -> Option<()>
pub fn for_each_entity<F>(&self, solution: &dyn Any, f: F) -> Option<()>
Calls f(index, entity) for every entity; returns None without an
extractor or on a solution type mismatch.