Struct ascesis::Context

pub struct Context { /* fields omitted */ }

A representation of shared state.

This is an umbrella type which, currently, includes a collection of Atoms, two symbol tables (one for structure names, and another for node names), node capacities, harc weights, and PartialContent of any c-e structure created in this Context.

For usage, see ContextHandle type, Contextual trait and InContext struct.

Methods

impl Context

pub fn new_toplevel<S>(name: S) -> Arc<Mutex<Context>> where
    S: AsRef<str>, 

Creates a new toplevel Context instance and returns the corresponding ContextHandle.

Calling this method is the only public way of creating toplevel Context instances.

pub fn reset(&mut self)

Clears content map, capacities, weights and runtime attributes, but doesn't destroy shared resources.

This method preserves the collection of [Atom]s, the two symbol tables, and the Context's own given name and group ID.

pub fn new_derived<S>(
    name: S,
    parent: &Arc<Mutex<Context>>
) -> Arc<Mutex<Context>> where
    S: AsRef<str>, 

Creates a new derived Context instance and returns a corresponding ContextHandle.

Calling this method is the only public way of creating derived Context instances.

pub fn is_toplevel(&self) -> bool

pub fn is_derived(&self) -> bool

pub fn get_name(&self) -> &str

pub fn share_node_name<S>(&mut self, node_name: S) -> NodeID where
    S: AsRef<str>, 

pub fn get_node_name(&self, node_id: NodeID) -> Option<&str>

pub fn get_node_id<S>(&self, node_name: S) -> Option<NodeID> where
    S: AsRef<str>, 

pub fn is_port(&self, atom_id: NonZeroUsize) -> bool

pub fn is_link(&self, atom_id: NonZeroUsize) -> bool

pub fn is_harc(&self, atom_id: NonZeroUsize) -> bool

pub fn is_fork(&self, atom_id: NonZeroUsize) -> bool

pub fn is_join(&self, atom_id: NonZeroUsize) -> bool

pub fn share_port(&mut self, port: &mut Port) -> PortID

pub fn share_link(&mut self, link: &mut Link) -> LinkID

pub fn share_fork(&mut self, fork: &mut Harc) -> ForkID

pub fn share_join(&mut self, join: &mut Harc) -> JoinID

pub fn get_port(&self, port_id: PortID) -> Option<&Port>

pub fn get_link(&self, link_id: LinkID) -> Option<&Link>

pub fn get_harc(&self, atom_id: NonZeroUsize) -> Option<&Harc>

pub fn get_fork(&self, fork_id: ForkID) -> Option<&Harc>

pub fn get_join(&self, join_id: JoinID) -> Option<&Harc>

pub fn get_antiport_id(&self, port_id: PortID) -> Option<PortID>

pub fn add_content<S>(
    &mut self,
    name: S,
    content: PartialContent
) -> Option<PartialContent> where
    S: AsRef<str>, 

pub fn get_content<S>(&self, name: S) -> Option<&PartialContent> where
    S: AsRef<str>, 

pub fn has_content<S>(&self, name: S) -> bool where
    S: AsRef<str>, 

pub fn set_capacity_by_name<S>(
    &mut self,
    node_name: S,
    cap: Multiplicity
) -> Option<Multiplicity> where
    S: AsRef<str>, 

pub fn get_capacity(&self, node_id: NodeID) -> Multiplicity

pub fn set_weight_by_name<S, I>(
    &mut self,
    face: Face,
    host_name: S,
    suit_names: I,
    weight: Multiplicity
) -> Option<Multiplicity> where
    I: IntoIterator,
    S: AsRef<str>,
    <I as IntoIterator>::Item: AsRef<str>, 

pub fn set_inhibitor_by_name<S, I>(
    &mut self,
    face: Face,
    host_name: S,
    suit_names: I
) -> Option<Multiplicity> where
    I: IntoIterator,
    S: AsRef<str>,
    <I as IntoIterator>::Item: AsRef<str>, 

pub fn get_weight(&self, atom_id: NonZeroUsize) -> Multiplicity

pub fn set_encoding(&mut self, encoding: Encoding)

pub fn get_encoding(&self) -> Option<Encoding>

pub fn set_search(&mut self, search: Search)

pub fn get_search(&self) -> Option<Search>

pub fn set_semantics(&mut self, semantics: Semantics)

pub fn get_semantics(&self) -> Option<Semantics>

pub fn set_max_steps(&mut self, max_steps: usize)

pub fn get_max_steps(&self) -> Option<usize>

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.

impl Eq for Context

impl PartialEq<Context> for Context

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Context> for Context

fn partial_cmp(&self, other: &Context) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.