Skip to main content

PluginInvocation

Enum PluginInvocation 

Source
pub enum PluginInvocation<'a> {
    Step {
        phase: DispatchPhase,
    },
    Field {
        name: &'a str,
        value: &'a Value,
        phase: DispatchPhase,
    },
}
Expand description

Context for one plugin invocation: tells the invoker the intent of the call so it can dispatch to the right CPEX hook contract.

Step is the policy / post_policy case — the invoker (apl-cpex side) already holds a typed payload reference; APL doesn’t need to pass one.

Field is the pipe-chain case — APL is focused on a specific field value mid-transform and the plugin may rewrite that value via PluginOutcome.modified_value.

Both variants carry a DispatchPhase so the invoker can resolve the right hook entry against the cpex-core hook routing table when the plugin registered for multiple hooks.

Variants§

§

Step

Called from a policy: or post_policy: step. The plugin operates on whatever typed payload the invoker was bound to.

Fields

§

Field

Called inside an args: / result: pipe chain on one field.

Fields

§name: &'a str
§value: &'a Value

Implementations§

Source§

impl<'a> PluginInvocation<'a>

Source

pub fn phase(&self) -> DispatchPhase

Convenience: the dispatch phase carried by this invocation.

Trait Implementations§

Source§

impl<'a> Clone for PluginInvocation<'a>

Source§

fn clone(&self) -> PluginInvocation<'a>

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<'a> Copy for PluginInvocation<'a>

Source§

impl<'a> Debug for PluginInvocation<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for PluginInvocation<'a>

§

impl<'a> RefUnwindSafe for PluginInvocation<'a>

§

impl<'a> Send for PluginInvocation<'a>

§

impl<'a> Sync for PluginInvocation<'a>

§

impl<'a> Unpin for PluginInvocation<'a>

§

impl<'a> UnsafeUnpin for PluginInvocation<'a>

§

impl<'a> UnwindSafe for PluginInvocation<'a>

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.