Enum HookPoint 

pub enum HookPoint {
    ComponentPreInit,
    ComponentPostInit,
    ComponentPreShutdown,
    ComponentPostShutdown,
    RequestPreDispatch,
    RequestPostDispatch,
    SignalPreDispatch,
    SignalPostDispatch,
    ChildPreSpawn,
    ChildPostSpawn,
    ChildPreRun,
    ChildPostRun,
    ChannelPreCreate,
    ChannelPostCreate,
    ChannelPreDestroy,
    ChannelPostDestroy,
    ToolPreExecute,
    ToolPostExecute,
    AuthPreCheck,
    AuthPostCheck,
    AuthOnGrant,
    BusPreBroadcast,
    BusPostBroadcast,
    BusOnRegister,
    BusOnUnregister,
}

All lifecycle points where hooks can intercept.

Variants

ComponentPreInit

Before Component::init().

ComponentPostInit

After Component::init() succeeds.

ComponentPreShutdown

Before Component::shutdown().

ComponentPostShutdown

After Component::shutdown().

RequestPreDispatch

Before Component::on_request().

RequestPostDispatch

After Component::on_request() completes.

SignalPreDispatch

Before signal is dispatched to component.

SignalPostDispatch

After signal dispatch completes.

ChildPreSpawn

Before ChildSpawner::spawn().

ChildPostSpawn

After child is spawned successfully.

ChildPreRun

Before RunnableChild::run().

ChildPostRun

After RunnableChild::run() completes.

ChannelPreCreate

Before OrcsEngine::spawn_runner*().

ChannelPostCreate

After channel runner is created.

ChannelPreDestroy

Before channel runner loop exits.

ChannelPostDestroy

After channel is fully torn down.

ToolPreExecute

Before Lua tool function executes.

ToolPostExecute

After Lua tool function completes.

AuthPreCheck

Before permission check.

AuthPostCheck

After permission check.

AuthOnGrant

On dynamic permission grant.

BusPreBroadcast

Before EventBus::broadcast().

BusPostBroadcast

After EventBus::broadcast().

BusOnRegister

On component registration with EventBus.

BusOnUnregister

On component unregistration from EventBus.

Implementations

impl HookPoint

pub const KNOWN_PREFIXES: &'static [&'static str]

All known HookPoint prefix categories (for shorthand parsing in Phase 3).

pub fn is_pre(&self) -> bool

Returns true if this is a “pre” hook (can modify/abort the operation).

pub fn is_post(&self) -> bool

Returns true if this is a “post” hook (observe-only by default).

pub fn is_event(&self) -> bool

Returns true if this is an “on” event hook (neither pre nor post).

pub fn as_str(&self) -> &'static str

Returns the canonical string representation.

Trait Implementations

impl Clone for HookPoint

fn clone(&self) -> HookPoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookPoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HookPoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HookPoint

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

Formats the value using the given formatter.

impl FromStr for HookPoint

type Err = HookError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for HookPoint

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 PartialEq for HookPoint

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for HookPoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for HookPoint

impl Eq for HookPoint

impl StructuralPartialEq for HookPoint