Struct RiQueueModule 

pub struct RiQueueModule { /* private fields */ }

Main queue module implementing the async service module trait.

This module provides the main entry point for the queue system, integrating with the Ri service module system for lifecycle management.

Implementations

impl RiQueueModule

pub async fn new(config: RiQueueConfig) -> RiResult<Self>

Creates a new queue module with the given configuration.

Parameters

• config: The queue configuration to use

Returns

A RiResult<Self> containing the new queue module instance

pub fn with_config(_config: RiQueueConfig) -> RiResult<Self>

Creates a new queue module with the given configuration (synchronous version).

This is a synchronous wrapper for use in the builder pattern.

Parameters

• config: The queue configuration to use

Returns

A RiResult<Self> containing the new queue module instance

pub fn queue_manager(&self) -> Arc<RiQueueManager>

Returns a reference to the queue manager.

Returns

An Arc providing thread-safe access to the queue manager

Trait Implementations

impl AsyncServiceModule for RiQueueModule

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Initializes the queue module.

This method delegates to the queue manager’s initialization method.

Parameters

• _ctx: The service context (not used in this implementation)

Returns

A RiResult<()> indicating success or failure

fn after_shutdown<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Performs cleanup after the application has shut down.

This method delegates to the queue manager’s shutdown method.

Parameters

• _ctx: The service context (not used in this implementation)

Returns

A RiResult<()> indicating success or failure

fn name(&self) -> &str

Returns the name of the queue module.

Returns

The module name as a string

fn is_critical(&self) -> bool

Indicates whether the queue module is critical.

The queue module is non-critical, meaning that if it fails to initialize or operate, it should not break the entire application.

Returns

false since queue is non-critical

fn priority(&self) -> i32

Returns the priority of the internal module.

fn dependencies(&self) -> Vec<&str>

Returns the list of module dependencies.

fn before_start<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Prepares the internal module for startup.

fn start<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Starts the internal async service module.

fn after_start<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Performs post-startup operations for the internal module.

fn before_shutdown<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Prepares the internal module for shutdown.

fn shutdown<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Shuts down the internal async service module.

impl<'py> IntoPyObject<'py> for RiQueueModule

type Target = RiQueueModule

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiQueueModule

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"Main queue module implementing the async service module trait.\n\nThis module provides the main entry point for the queue system, integrating with the\nRi service module system for lifecycle management.\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<RiQueueModule>

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 RiQueueModule

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

impl PyMethods<RiQueueModule> for PyClassImplCollector<RiQueueModule>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiQueueModule

const NAME: &'static str = "RiQueueModule"

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 ServiceModule for RiQueueModule

fn name(&self) -> &str

Returns the name of the service module.

fn is_critical(&self) -> bool

Indicates if the module is critical to the operation of the system.

fn priority(&self) -> i32

Returns the priority of the module.

fn dependencies(&self) -> Vec<&str>

Returns the list of module dependencies.

fn init(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Initializes the service module.

fn start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Starts the service module.

fn shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Shuts down the service module.

fn before_start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Prepares the module for startup.

fn after_start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Performs post-startup operations.

fn before_shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Prepares the module for shutdown.

fn after_shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Performs post-shutdown cleanup.

impl DerefToPyAny for RiQueueModule

impl ExtractPyClassWithClone for RiQueueModule