Struct RiHookEvent 

pub struct RiHookEvent {
    pub kind: RiHookKind,
    pub module: Option<String>,
    pub phase: Option<RiModulePhase>,
}

Hook event structure.

This struct represents an event that is emitted when a hook is triggered. It contains information about the hook kind, the module (if applicable), and the module phase (if applicable).

Fields

kind: RiHookKind

The kind of hook that was triggered

module: Option<String>

The name of the module associated with the event (if any)

phase: Option<RiModulePhase>

The module phase associated with the event (if any)

Implementations

impl RiHookEvent

pub fn new( kind: RiHookKind, module: Option<String>, phase: Option<RiModulePhase>, ) -> Self

Creates a new hook event.

pub fn config_reload(_path: String, _timestamp: DateTime<Utc>) -> Self

Creates a config reload event.

Trait Implementations

impl Clone for RiHookEvent

fn clone(&self) -> RiHookEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RiHookEvent

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

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for RiHookEvent

type Target = RiHookEvent

The Python output type

type Output = Bound<'py, <RiHookEvent 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 RiHookEvent

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiHookEvent

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 event structure.\n\nThis struct represents an event that is emitted when a hook is triggered. It contains\ninformation about the hook kind, the module (if applicable), and the module phase (if applicable).\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<RiHookEvent>

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 PyTypeInfo for RiHookEvent

const NAME: &'static str = "RiHookEvent"

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 RiHookEvent

impl ExtractPyClassWithClone for RiHookEvent