Skip to main content

DispatchMethod

Struct DispatchMethod 

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

A single method belonging to a GenericFunction.

Pairs a parameter-shape signature with an executable MethodBody and a MethodRole; methods are matched against call arguments through the kernel Shape protocol.

Implementations§

Source§

impl DispatchMethod

Source

pub fn new( id: Symbol, role: MethodRole, parameter_shapes: Vec<Arc<dyn Shape>>, body: MethodBody, ) -> Self

Builds a method from its id, role, parameter shapes, and body.

Source

pub fn id(&self) -> &Symbol

Returns the symbol identifying this method.

Source

pub fn role(&self) -> MethodRole

Returns the method’s role in the combination.

Source

pub fn arity(&self) -> usize

Returns the method’s arity (its number of parameter shapes).

Source

pub fn parameter_shapes(&self) -> &[Arc<dyn Shape>]

Returns the parameter shapes this method matches against, in order.

Source

pub fn hints(&self) -> &[HintMetadata]

Returns the operation hints attached to this method.

Source

pub fn with_hint(self, hint: HintMetadata) -> Self

Adds an operation hint to this method.

Source

pub fn with_argument_hint( self, argument: Symbol, detail: impl Into<String>, ) -> Self

Adds a hint describing one method argument.

Source

pub fn with_capability_requirement(self, capability: CapabilityName) -> Self

Adds a hint describing a capability requirement.

Source

pub fn with_codec_safe_form(self, form: Symbol) -> Self

Adds a hint describing a codec-safe form.

Source

pub fn with_example(self, example: impl Into<String>) -> Self

Adds a runnable or displayable operation example.

Source

pub fn match_args( &self, cx: &mut Cx, args: &[Value], ) -> Result<Option<MethodSpecificity>>

Tests the method against args, returning its specificity if applicable.

Returns None on arity mismatch or if any parameter shape rejects its argument; otherwise returns the accumulated MethodSpecificity.

Source

pub fn invoke(&self, cx: &mut Cx, args: &[Value]) -> Result<Value>

Runs the method body against args, returning its result.

Trait Implementations§

Source§

impl Clone for DispatchMethod

Source§

fn clone(&self) -> DispatchMethod

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

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.