Struct syndicate::actor::Cap

pub struct Cap { /* private fields */ }

Specialization of Ref<M> for messages/assertions of type AnyValue.

All polyglot and network communication is done in terms of Caps.

Caps can also be attenuated (Hardy 2017; Miller 2006) to reduce (or otherwise transform) the range of assertions and messages they can be used to send to their referent. The Syndicated Actor model uses Macaroon-style capability attenuation.

Implementations

impl Cap

pub fn guard<L: 'static + Sync + Send, M>( literals: &Arc<L>, underlying: Arc<Ref<M>> ) -> Arc<Self>where M: for<'a> Unparse<&'a L, AnyValue> + for<'a> Parse<&'a L, AnyValue> + 'static + Send,

Given a Ref<M>, where M is interconvertible with AnyValue, yields a Cap for the referenced entity. The Cap automatically decodes presented AnyValues into instances of M.

pub fn new(underlying: &Arc<Ref<AnyValue>>) -> Arc<Self>

Directly constructs a Cap for underlying.

pub fn attenuate(&self, caveats: &[Caveat]) -> Result<Arc<Self>, CaveatError>

Yields a fresh Cap for self’s underlying, copying the existing attenuation of self to the new Cap and adding the caveats to it.

pub fn rewrite(&self, a: AnyValue) -> Option<AnyValue>

Applies the contained attenuation to a, yielding None if a is filtered out, or Some(_) if it is accepted (and possibly transformed).

pub fn assert<L, M: Unparse<L, AnyValue>>( &self, t: &mut Activation<'_>, literals: L, m: &M ) -> Option<Handle>

Translates m into an AnyValue, passes it through rewrite, and then asserts it using the activation t.

pub fn update<L, M: Unparse<L, AnyValue>>( &self, t: &mut Activation<'_>, handle: &mut Option<Handle>, literals: L, m: Option<&M> )

update is to assert as Activation::update is to Activation::assert.

pub fn message<L, M: Unparse<L, AnyValue>>( &self, t: &mut Activation<'_>, literals: L, m: &M )

Translates m into an AnyValue, passes it through rewrite, and then sends it via method message on the activation t.

pub fn sync(&self, t: &mut Activation<'_>, peer: Arc<Ref<Synced>>)

Synchronizes with the reference underlying the cap.

pub fn debug_str(&self) -> String

Trait Implementations

impl Clone for Cap

fn clone(&self) -> Cap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cap

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

Formats the value using the given formatter.

impl Domain for Cap

fn debug_encode<W>(&self, w: &mut W) -> Result<(), Error>where W: Writer,

impl From<&Cap> for IOValue

fn from(_v: &Cap) -> IOValue

Converts to this type from the input type.

impl Hash for Cap

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 Ord for Cap

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Cap> for Cap

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

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

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

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

impl PartialOrd<Cap> for Cap

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

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

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

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

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

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

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

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

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 TryFrom<&IOValue> for Cap

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(_v: &IOValue) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Cap

impl StructuralEq for Cap

impl StructuralPartialEq for Cap