[][src]Struct rustc_ap_rustc_data_structures::unify::UnificationTable

pub struct UnificationTable<S> where
    S: UnificationStore
{ /* fields omitted */ }

Table of unification keys and their values. You must define a key type K that implements the UnifyKey trait. Unification tables can be used in two-modes:

  • in-place (UnificationTable<InPlace<K>> or InPlaceUnificationTable<K>):
    • This is the standard mutable mode, where the array is modified in place.
    • To do backtracking, you can employ the snapshot and rollback_to methods.
  • persistent (UnificationTable<Persistent<K>> or PersistentUnificationTable<K>):
    • In this mode, we use a persistent vector to store the data, so that cloning the table is an O(1) operation.
    • This implies that ordinary operations are quite a bit slower though.
    • Requires the persistent feature be selected in your Cargo.toml file.

Methods

impl<S> UnificationTable<S> where
    S: UnificationStore
[src]

pub fn new() -> UnificationTable<S>[src]

pub fn snapshot(&mut self) -> Snapshot<S>[src]

Starts a new snapshot. Each snapshot must be either rolled back or committed in a "LIFO" (stack) order.

pub fn rollback_to(&mut self, snapshot: Snapshot<S>)[src]

Reverses all changes since the last snapshot. Also removes any keys that have been created since then.

pub fn commit(&mut self, snapshot: Snapshot<S>)[src]

Commits all changes since the last snapshot. Of course, they can still be undone if there is a snapshot further out.

pub fn new_key(
    &mut self,
    value: <S as UnificationStore>::Value
) -> <S as UnificationStore>::Key
[src]

Creates a fresh key with the given value.

pub fn reserve(&mut self, num_new_keys: usize)[src]

Reserve memory for num_new_keys to be created. Does not actually create the new keys; you must then invoke new_key.

pub fn reset_unifications(
    &mut self,
    value: impl FnMut(<S as UnificationStore>::Key) -> <S as UnificationStore>::Value
)
[src]

Clears all unifications that have been performed, resetting to the initial state. The values of each variable are given by the closure.

pub fn len(&self) -> usize[src]

Returns the number of keys created so far.

Important traits for Range<A>
pub fn vars_since_snapshot(
    &self,
    snapshot: &Snapshot<S>
) -> Range<<S as UnificationStore>::Key>
[src]

Returns the keys of all variables created since the snapshot.

impl<S, K, V> UnificationTable<S> where
    K: UnifyKey<Value = V>,
    S: UnificationStore<Key = K, Value = V>,
    V: UnifyValue
[src]

//////////////////////////////////////////////////////////////////////// Public API

pub fn union<K1, K2>(&mut self, a_id: K1, b_id: K2) where
    K1: Into<K>,
    K2: Into<K>,
    V: UnifyValue<Error = NoError>, 
[src]

Unions two keys without the possibility of failure; only applicable when unify values use NoError as their error type.

pub fn union_value<K1>(&mut self, id: K1, value: V) where
    K1: Into<K>,
    V: UnifyValue<Error = NoError>, 
[src]

Unions a key and a value without the possibility of failure; only applicable when unify values use NoError as their error type.

pub fn unioned<K1, K2>(&mut self, a_id: K1, b_id: K2) -> bool where
    K1: Into<K>,
    K2: Into<K>, 
[src]

Given two keys, indicates whether they have been unioned together.

pub fn find<K1>(&mut self, id: K1) -> K where
    K1: Into<K>, 
[src]

Given a key, returns the (current) root key.

pub fn unify_var_var<K1, K2>(
    &mut self,
    a_id: K1,
    b_id: K2
) -> Result<(), <V as UnifyValue>::Error> where
    K1: Into<K>,
    K2: Into<K>, 
[src]

Unions together two variables, merging their values. If merging the values fails, the error is propagated and this method has no effect.

pub fn unify_var_value<K1>(
    &mut self,
    a_id: K1,
    b: V
) -> Result<(), <V as UnifyValue>::Error> where
    K1: Into<K>, 
[src]

Sets the value of the key a_id to b, attempting to merge with the previous value.

pub fn probe_value<K1>(&mut self, id: K1) -> V where
    K1: Into<K>, 
[src]

Returns the current value for the given key. If the key has been union'd, this will give the value from the current root.

pub fn inlined_probe_value<K1>(&mut self, id: K1) -> V where
    K1: Into<K>, 
[src]

Trait Implementations

impl<S> Clone for UnificationTable<S> where
    S: UnificationStore + Clone
[src]

impl<S> Debug for UnificationTable<S> where
    S: UnificationStore + Debug
[src]

impl<S> Default for UnificationTable<S> where
    S: UnificationStore + Default
[src]

Auto Trait Implementations

impl<S> RefUnwindSafe for UnificationTable<S> where
    S: RefUnwindSafe

impl<S> Send for UnificationTable<S> where
    S: Send

impl<S> Sync for UnificationTable<S> where
    S: Sync

impl<S> Unpin for UnificationTable<S> where
    S: Unpin

impl<S> UnwindSafe for UnificationTable<S> where
    S: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<'a, T> Captures<'a> for T where
    T: ?Sized
[src]

impl<T> Erased for T[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<E> SpecializationError for E[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.