Struct Model

pub struct Model {
    pub dominance: Option<Expression>,
    pub context: Arc<RwLock<Context<'static>>>,
    /* private fields */
}

An Essence model.

• This type wraps a [Submodel] containing the top-level lexical scope. To manipulate the model’s constraints or symbols, first convert it to a [Submodel] using as_submodel / as_submodel_mut.

• To de/serialise a model using serde, see SerdeModel.

Fields

dominance: Option<Expression>

context: Arc<RwLock<Context<'static>>>

Implementations

impl Model

pub fn new(context: Arc<RwLock<Context<'static>>>) -> Model

Creates a new model.

pub fn as_submodel(&self) -> &SubModel

Returns this model as a [Submodel].

pub fn as_submodel_mut(&mut self) -> &mut SubModel

Returns this model as a mutable [Submodel].

pub fn replace_submodel(&mut self, new_submodel: SubModel) -> SubModel

Replaces the model contents with new_submodel, returning the old contents.

Trait Implementations

impl Biplate<Expression> for Model

fn biplate(&self) -> (Tree<Expression>, Box<dyn Fn(Tree<Expression>) -> Model>)

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn transform_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, Arc<dyn Fn(To) -> Self>)>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, Arc<dyn Fn(To) -> Self>)>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Biplate<SubModel> for Model

fn biplate(&self) -> (Tree<SubModel>, Box<dyn Fn(Tree<SubModel>) -> Model>)

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn transform_bi(&self, op: Arc<dyn Fn(To) -> To>) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, Arc<dyn Fn(To) -> Self>)>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, Arc<dyn Fn(To) -> Self>)>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Clone for Model

fn clone(&self) -> Model

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Model

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

Formats the value using the given formatter.

impl Default for Model

fn default() -> Model

Returns the “default value” for a type.

impl Display for Model

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

Formats the value using the given formatter.

impl From<Model> for SerdeModel

fn from(val: Model) -> SerdeModel

Converts to this type from the input type.

impl PartialEq for Model

fn eq(&self, other: &Model) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Typeable for Model

fn return_type(&self) -> Option<ReturnType>

impl Uniplate for Model

fn uniplate(&self) -> (Tree<Model>, Box<dyn Fn(Tree<Model>) -> Model>)

Definition of a Uniplate.

fn descend(&self, op: Arc<dyn Fn(Self) -> Self>) -> Self

Applies a function to all direct children of this

fn universe(&self) -> VecDeque<Self>

Gets all children of a node, including itself and all children.

fn children(&self) -> VecDeque<Self>

Gets the direct children (maximal substructures) of a node.

fn with_children(&self, children: VecDeque<Self>) -> Self

Reconstructs the node with the given children.

fn transform(&self, f: Arc<dyn Fn(Self) -> Self>) -> Self

Applies the given function to all nodes bottom up.

fn rewrite(&self, f: Arc<dyn Fn(Self) -> Option<Self>>) -> Self

Rewrites by applying a rule everywhere it can.

fn cata<T>(&self, op: Arc<dyn Fn(Self, VecDeque<T>) -> T>) -> T

Performs a fold-like computation on each value.

fn holes(&self) -> impl Iterator<Item = (Self, Arc<dyn Fn(Self) -> Self>)>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts(&self) -> impl Iterator<Item = (Self, Arc<dyn Fn(Self) -> Self>)>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Eq for Model