Struct RiHookBus 

pub struct RiHookBus { /* private fields */ }

Hook bus for registering and emitting hooks.

This struct manages the registration of hook handlers and the emission of hook events. It allows multiple handlers to be registered for the same hook kind.

Implementations

impl RiHookBus

pub fn new() -> Self

Creates a new hook bus instance.

Returns a new RiHookBus instance with no registered handlers.

pub fn register<F>(&mut self, kind: RiHookKind, id: RiHookId, handler: F)

where F: Fn(&RiServiceContext, &RiHookEvent) -> RiResult<()> + Send + Sync + 'static,

Registers a hook handler for a specific hook kind.

Parameters

• kind: The hook kind to register the handler for
• id: A unique ID for the hook handler (1-128 alphanumeric chars, dash, underscore)
• handler: The handler function to execute when the hook is emitted

Security

Hook IDs are validated to prevent injection attacks. Only alphanumeric characters, dashes, and underscores are allowed.

The handler function takes a RiServiceContext and a RiHookEvent and returns a RiResult<()>.

pub fn emit(&self, kind: &RiHookKind, ctx: &RiServiceContext) -> RiResult<()>

Emits a hook event of the specified kind.

Parameters

• kind: The hook kind to emit
• ctx: The service context to pass to the hook handlers

Returns

A RiResult<()> indicating success or failure

pub fn emit_with( &self, kind: &RiHookKind, ctx: &RiServiceContext, module: Option<&str>, phase: Option<RiModulePhase>, ) -> RiResult<()>

Emits a hook event with additional contextual information.

Parameters

• kind: The hook kind to emit
• ctx: The service context to pass to the hook handlers
• module: The name of the module associated with the event (if any)
• phase: The module phase associated with the event (if any)

Returns

A RiResult<()> indicating success or failure

pub fn emit_simple( &self, kind: &RiHookKind, module: Option<&str>, phase: Option<RiModulePhase>, ) -> RiResult<()>

Emits a hook event without a service context.

This is a simplified version of emit that creates a default context.

Parameters

• kind: The hook kind to emit
• module: The name of the module associated with the event (if any)
• phase: The module phase associated with the event (if any)

Returns

A RiResult<()> indicating success or failure

pub fn has_handlers(&self, kind: &RiHookKind) -> bool

Checks if there are any handlers registered for a hook kind.

Parameters

• kind: The hook kind to check

Returns

true if there are handlers registered, false otherwise

Trait Implementations

impl Default for RiHookBus

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for RiHookBus

type Target = RiHookBus

The Python output type

type Output = Bound<'py, <RiHookBus as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiHookBus

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiHookBus

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"Hook bus for registering and emitting hooks.\n\nThis struct manages the registration of hook handlers and the emission of hook events.\nIt allows multiple handlers to be registered for the same hook kind.\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiHookBus>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for RiHookBus

const TEXT_SIGNATURE: &'static str = "()"

impl PyMethods<RiHookBus> for PyClassImplCollector<RiHookBus>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiHookBus

const NAME: &'static str = "RiHookBus"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for RiHookBus

impl ExtractPyClassWithClone for RiHookBus