Struct Protected

pub struct Protected<C> { /* private fields */ }

A container of objects, typically either terms or objects containing terms, that are of trait Markable. These store ATermRef<’static> that are protected during garbage collection by being in the container itself.

Implementations

impl<C: Markable + Send + 'static> Protected<C>

pub fn new(container: C) -> Protected<C>

Creates a new Protected container from a given container.

pub fn write(&mut self) -> Protector<'_, C>

Provides mutable access to the underlying container. Use Protector::protect of the resulting guard to be able to insert terms into the container. Otherwise the borrow checker will note that the ATermRef do not outlive the guard, see Protector.

pub fn read(&self) -> &C

Provides immutable access to the underlying container.

Trait Implementations

impl<C: Clone + Markable + Send + 'static> Clone for Protected<C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Markable> Debug for Protected<C>

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

Formats the value using the given formatter.

impl<C: Default + Markable + Send + 'static> Default for Protected<C>

fn default() -> Self

Returns the “default value” for a type.

impl<C> Drop for Protected<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: Hash + Markable> Hash for Protected<C>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<C: Ord + PartialEq + PartialOrd + Markable> Ord for Protected<C>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<C: PartialEq + Markable> PartialEq for Protected<C>

fn eq(&self, other: &Self) -> 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<C: PartialOrd + Markable> PartialOrd for Protected<C>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<C: Eq + PartialEq + Markable> Eq for Protected<C>