Skip to main content

EntityDescriptor

Struct EntityDescriptor 

Source
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 str

Name of the entity type.

§type_id: TypeId

TypeId of the entity type.

§logical_id: Option<EntityClassId>

Logical entity class ID for dynamic binding models.

§solution_field: &'static str

Field name in the solution (for entity collections).

§is_collection: bool

Whether 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

Source

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.

Source

pub fn with_extractor(self, extractor: Box<dyn EntityExtractor>) -> Self

Sets the extractor used to read entities out of a solution.

Source

pub fn with_logical_id(self, logical_id: EntityClassId) -> Self

Sets the logical entity class ID used by dynamic bindings.

Source

pub fn with_variable(self, descriptor: VariableDescriptor) -> Self

Appends a variable descriptor.

Source

pub fn with_id_field(self, field: &'static str) -> Self

Names the entity’s planning ID field.

Source

pub fn with_pin_field(self, field: &'static str) -> Self

Names the entity’s pinning field.

Source

pub fn with_pin_predicate(self, predicate: fn(&dyn Any) -> bool) -> Self

Supplies the entity-level pin predicate for a manually assembled descriptor.

Source

pub fn is_pinned(&self, solution: &dyn Any, index: usize) -> bool

Returns whether this entity is pinned. Descriptors without a predicate are unrestricted.

Source

pub fn has_pin_predicate(&self) -> bool

Returns true when a pin predicate is configured.

Source

pub fn genuine_variable_descriptors( &self, ) -> impl Iterator<Item = &VariableDescriptor>

Iterates over the genuine (scalar and list) variables.

Source

pub fn shadow_variable_descriptors( &self, ) -> impl Iterator<Item = &VariableDescriptor>

Iterates over the shadow variables.

Source

pub fn find_variable(&self, name: &str) -> Option<&VariableDescriptor>

Finds a variable by field name.

Source

pub fn has_genuine_variables(&self) -> bool

Returns true when the entity declares at least one genuine variable.

Source

pub fn has_extractor(&self) -> bool

Returns true when an extractor is configured.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn for_each_entity<F>(&self, solution: &dyn Any, f: F) -> Option<()>
where F: FnMut(usize, &dyn Any),

Calls f(index, entity) for every entity; returns None without an extractor or on a solution type mismatch.

Source

pub fn for_each_entity_mut<F>(&self, solution: &mut dyn Any, f: F) -> Option<()>
where F: FnMut(usize, &mut dyn Any),

Calls f(index, entity) with mutable access for every entity; returns None without an extractor or on a solution type mismatch.

Trait Implementations§

Source§

impl Clone for EntityDescriptor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for EntityDescriptor

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.