Skip to main content

MethodRef

Struct MethodRef 

Source
pub struct MethodRef { /* private fields */ }
Expand description

A fully qualified Plexus method — the activation namespace and the method name, kept as separate fields because the transports need them differently:

TransportUses
WebSocket JSON-RPC"{path}.{method}" as the params.method of a {hub}.call subscription
REST + SSEPOST /rest/{namespace}/{method}
in-processnamespace selects the activation, method is passed to Activation::call

A pre-joined &str would force every transport to re-split it, and a mis-split is silent. The generated client emits MethodRef::new(..) as a const, so this costs nothing at the call site.

MACRO-16: a method of a #[child] activation is reached through its parent — tickets.inputs.answer, not inputs.answer. MethodRef::at gives the reference the dotted path the activation is mounted at ("tickets.inputs"); MethodRef::qualified then answers "{path}.{method}". Without a path (every MethodRef::new) the path is the namespace, exactly as before.

Implementations§

Source§

impl MethodRef

Source

pub const fn new(namespace: &'static str, method: &'static str) -> Self

Source

pub fn at(self, path: &'static str) -> Self

The same method on the activation mounted at path — the dotted route from the hub to it, e.g. "tickets.inputs" for the inputs child of tickets. A path equal to the namespace, or empty, is the top-level reference itself (so at never makes two equal methods compare unequal).

Source

pub const fn namespace(&self) -> &'static str

The activation namespace, e.g. "tickets" (a child’s own, e.g. "inputs").

Source

pub const fn method(&self) -> &'static str

The bare method name, e.g. "watch".

Source

pub const fn path(&self) -> &'static str

The dotted path the activation is reached at: the namespace for a top-level activation, "tickets.inputs" for a child.

Source

pub fn qualified(&self) -> String

The dotted form the hub’s call method expects, e.g. "tickets.watch", or "tickets.inputs.answer" for a child’s method.

Trait Implementations§

Source§

impl Clone for MethodRef

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for MethodRef

Source§

impl Debug for MethodRef

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for MethodRef

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MethodRef

Source§

impl Hash for MethodRef

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for MethodRef

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MethodRef

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.