Struct RiServiceContext 

pub struct RiServiceContext { /* private fields */ }

Public-facing service context for Ri applications.

The RiServiceContext is the primary way for modules and business logic to access core Ri functionalities. It follows the dependency injection pattern, providing a centralized access point to all core components.

Design Principle

The service context is designed to be immutable from the outside, with controlled access to mutable components through dedicated methods. This ensures thread safety while allowing for necessary mutations in specific contexts.

Usage

use ri::prelude::*;
 
async fn handle_request(ctx: &RiServiceContext) -> RiResult<()> {
    // Access logger
    ctx.logger().info("request", "Handling request");
     
    // Access configuration
    let config_value = ctx.config().config().get_str("app.name");
     
    // Access file system
    let file_path = ctx.fs().app_data_path("logs/app.log");
     
    Ok(())
}

Implementations

impl RiServiceContext

pub fn new_with( fs: RiFileSystem, logger: RiLogger, config: RiConfigManager, hooks: RiHookBus, metrics_registry: Option<Arc<RiMetricsRegistry>>, ) -> Self

Create a new RiServiceContext with the provided components.

This method is typically used by the framework itself during application startup, but can be used for testing or custom initialization.

Parameters

• fs: File system accessor
• logger: Structured logger
• config: Configuration manager
• hooks: Hook bus for lifecycle events
• metrics_registry: Optional metrics registry for observability

Returns

A new RiServiceContext instance.

pub fn new_default() -> RiResult<Self>

Create a new RiServiceContext with default configuration.

This is the most common way to create a service context, as it handles the initialization of all core components automatically.

Returns

A RiResult containing the new service context, or an error if initialization failed.

Errors

• If the project root directory cannot be determined
• If there are issues initializing any of the core components

pub fn fs(&self) -> &RiFileSystem

Get a reference to the file system accessor.

Returns

A reference to the RiFileSystem instance.

pub fn logger(&self) -> &RiLogger

Get a reference to the structured logger.

Returns

A reference to the RiLogger instance.

pub fn config(&self) -> Arc<RiConfigManager>

Get a reference to the configuration manager.

Returns

A reference to the RiConfigManager instance.

pub fn hooks(&self) -> Arc<RiHookBus>

Get a reference to the hook bus for emitting events.

Returns

A reference to the RiHookBus instance.

pub fn hooks_mut(&mut self) -> &mut RiHookBus

Get a mutable reference to the hook bus for registering handlers.

Returns

A mutable reference to the RiHookBus instance.

pub fn config_mut(&mut self) -> &mut RiConfigManager

Get a mutable reference to the configuration manager.

Returns

A mutable reference to the RiConfigManager instance.

pub fn fs_mut(&mut self) -> &mut RiFileSystem

Get a mutable reference to the file system accessor.

Returns

A mutable reference to to the RiFileSystem instance.

pub fn logger_mut(&mut self) -> &mut RiLogger

Get a mutable reference to the structured logger.

Returns

A mutable reference to the RiLogger instance.

pub fn metrics_registry(&self) -> Option<Arc<RiMetricsRegistry>>

Get a reference to the metrics registry if available.

Returns

An optional reference to the RiMetricsRegistry instance.

Trait Implementations

impl Clone for RiServiceContext

fn clone(&self) -> RiServiceContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'py> IntoPyObject<'py> for RiServiceContext

type Target = RiServiceContext

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiServiceContext

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"Public-facing service context for Ri applications.\n\nThe `RiServiceContext` is the primary way for modules and business logic to\naccess core Ri functionalities. It follows the dependency injection pattern,\nproviding a centralized access point to all core components.\n\n## Design Principle\n\nThe service context is designed to be immutable from the outside, with controlled\naccess to mutable components through dedicated methods. This ensures thread safety\nwhile allowing for necessary mutations in specific contexts.\n\n## Usage\n\n```rust\nuse ri::prelude::*;\n\nasync fn handle_request(ctx: &RiServiceContext) -> RiResult<()> {\n // Access logger\n ctx.logger().info(\"request\", \"Handling request\");\n \n // Access configuration\n let config_value = ctx.config().config().get_str(\"app.name\");\n \n // Access file system\n let file_path = ctx.fs().app_data_path(\"logs/app.log\");\n \n Ok(())\n}\n```\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<RiServiceContext>

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 RiServiceContext

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

impl PyMethods<RiServiceContext> for PyClassImplCollector<RiServiceContext>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiServiceContext

const NAME: &'static str = "RiServiceContext"

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 RiServiceContext

impl ExtractPyClassWithClone for RiServiceContext