Struct aces::Context

pub struct Context { /* fields omitted */ }

A representation of shared state.

This is an umbrella type which, currently, includes a collection of Atoms and two symbol tables, one for structure names, and another for node names.

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

Methods

impl Context

pub fn new_toplevel<S: AsRef<str>>(
    name: S,
    origin: ContentOrigin
) -> ContextHandle

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

Calling this method, or its variant, new_interactive(), is the only public way of creating toplevel Context instances.

pub fn new_interactive<S: AsRef<str>>(name: S) -> ContextHandle

Creates a new toplevel Context instance, sets content origin to ContentOrigin::Interactive and returns the corresponding ContextHandle.

This is a specialized variant of the new_toplevel() method.

pub fn reset(&mut self, new_origin: ContentOrigin)

pub fn new_derived<S: AsRef<str>>(
    name: S,
    parent: &ContextHandle
) -> ContextHandle

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: AsRef<str>>(&mut self, node_name: S) -> NodeID

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

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

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

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

pub fn is_split(&self, atom_id: AtomID) -> bool

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

pub fn is_join(&self, atom_id: AtomID) -> 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 Fork) -> ForkID

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

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

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

pub fn get_split(&self, atom_id: AtomID) -> Option<&Split>

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

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

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

impl Context

pub fn with<'a, T: Contextual>(&'a self, thing: &'a T) -> InContext<'a, T>

pub fn with_mut<'a, T: Contextual>(
    &'a self,
    thing: &'a mut T
) -> InContextMut<'a, T>

Trait Implementations

impl Eq for Context

impl PartialOrd<Context> for Context

fn partial_cmp(&self, other: &Self) -> 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.

impl PartialEq<Context> for Context

fn eq(&self, other: &Self) -> 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 Debug for Context

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

Formats the value using the given formatter.