tor_rpcbase::method

Trait DynMethod

Source 
pub trait DynMethod:
    Debug
    + Send
    + Downcast {
    // Provided methods
    fn invoke_without_dispatch(
        &self,
        ctx: Arc<dyn Context>,
        obj_id: &ObjectId,
    ) -> Result<RpcResultFuture, InvokeError> { ... }
    fn is_cancellable(&self) -> bool { ... }
}
Expand description

The parameters and method name associated with a given Request.

Use derive_deftly(DynMethod) for a template to declare one of these.

To be invoked from RPC, a method must additionally implement DeserMethod.

§Note

As a consequence of this trait being public, any crate can define a method on an object, even if the method and object are defined in another crate: This should be okay, since:

  • the crate should only have access to the public Rust methods of the object, which is presumably safe to call.
  • if you are linking a crate, you are already trusting that crate.

Provided Methods§

Source

fn invoke_without_dispatch( &self, ctx: Arc<dyn Context>, obj_id: &ObjectId, ) -> Result<RpcResultFuture, InvokeError>

Try to invoke a method while bypassing the regular RPC method dispatch system.

For nearly all DynMethod types, this method will return Err(InvokeError::NoDispatchBypass), indicating that the caller should fall through and use the regular method dispatch system.

This mechanism is suitable for cases like “rpc:release” where the correct behavior for the method does not depend at all on the type of the object it’s being invoked on, but instead the method is meant to manipulate the object reference itself.

Source

fn is_cancellable(&self) -> bool

Return true if this method is safe to cancel.

The default implementation returns true: all RPC methods should be cancel-safe and and cancellable.

In Arti currently, only the “cancel” method itself is marked as uncancellable, to avoid deadlocks.

Implementations§

Source§

impl dyn DynMethod

Source

pub fn is<__T: DynMethod>(&self) -> bool

Returns true if the trait object wraps an object of type __T.

Source

pub fn downcast<__T: DynMethod>(self: Box<Self>) -> Result<Box<__T>, Box<Self>>

Returns a boxed object from a boxed trait object if the underlying object is of type __T. Returns the original boxed trait if it isn’t.

Source

pub fn downcast_rc<__T: DynMethod>(self: Rc<Self>) -> Result<Rc<__T>, Rc<Self>>

Returns an Rc-ed object from an Rc-ed trait object if the underlying object is of type __T. Returns the original Rc-ed trait if it isn’t.

Source

pub fn downcast_ref<__T: DynMethod>(&self) -> Option<&__T>

Returns a reference to the object within the trait object if it is of type __T, or None if it isn’t.

Source

pub fn downcast_mut<__T: DynMethod>(&mut self) -> Option<&mut __T>

Returns a mutable reference to the object within the trait object if it is of type __T, or None if it isn’t.

Implementors§