Struct RiAppBuilder 

pub struct RiAppBuilder { /* private fields */ }

Public-facing application builder for Ri.

The RiAppBuilder provides a fluent API for configuring and building Ri applications. It follows the builder pattern, allowing users to configure various aspects of the application before building the final runtime.

Usage

use ri::prelude::*;
 
#[tokio::main]
async fn main() -> RiResult<()> {
    let app = RiAppBuilder::new()
        .with_config("config.yaml")?
        .with_module(Box::new(MySyncModule::new()))
        .with_async_module(Box::new(MyAsyncModule::new()))
        .build()?;
     
    app.run(|ctx| async move {
        ctx.logger().info("service", "Ri service started")?;
        Ok(())
    }).await
}

Implementations

impl RiAppBuilder

pub fn new() -> Self

Create a new empty application builder.

Returns

A new RiAppBuilder instance with default settings.

pub fn with_module(self, module: Box<dyn ServiceModule>) -> Self

Add a synchronous module to the application.

Parameters

• module: A boxed synchronous module implementing ServiceModule

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_python_module(self, module: RiPythonModuleAdapter) -> Self

Add a Python module to the application.

This method adds a module created from Python code to the application. The module will be treated as an asynchronous Ri module.

Parameters

• module: A Python module adapter implementing module configuration

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_async_module(self, module: Box<dyn AsyncServiceModule>) -> Self

Add an asynchronous module to the application.

Parameters

• module: A boxed asynchronous module implementing AsyncServiceModule

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_dms_module(self, module: Box<dyn RiModule>) -> Self

Add a Ri module to the application.

This method adds a module implementing the public RiModule trait to the application. The module will be treated as an asynchronous module.

Parameters

• module: A boxed module implementing RiModule

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_modules(self, modules: Vec<Box<dyn ServiceModule>>) -> Self

Add multiple synchronous modules to the application.

Parameters

• modules: A vector of boxed synchronous modules implementing ServiceModule

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_async_modules( self, modules: Vec<Box<dyn AsyncServiceModule>>, ) -> Self

Add multiple asynchronous modules to the application.

Parameters

• modules: A vector of boxed asynchronous modules implementing AsyncServiceModule

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_dms_modules(self, modules: Vec<Box<dyn RiModule>>) -> Self

Add multiple Ri modules to the application.

This method adds multiple modules implementing the public RiModule trait to the application. Each module will be treated as an asynchronous module.

Parameters

• modules: A vector of boxed modules implementing RiModule

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_config(self, config_path: impl Into<String>) -> RiResult<Self>

Add a configuration file to the application.

Parameters

• config_path: Path to the configuration file

Returns

A RiResult containing the updated RiAppBuilder instance for method chaining.

Errors

This method currently never returns an error, but returns RiResult for consistency with other builder methods and to allow for future error handling.

pub fn with_logging(self, logging_config: RiLogConfig) -> Self

Set custom logging configuration for the application.

Parameters

• logging_config: Custom logging configuration

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_observability( self, observability_config: RiObservabilityConfig, ) -> Self

Set custom observability configuration for the application.

Parameters

• observability_config: Custom observability configuration

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_cache_module<F>(self, config_fn: F) -> Self

where F: FnOnce(&mut RiCacheConfig) -> &mut RiCacheConfig,

Add cache module with configuration.

This method adds a cache module to the application with custom configuration. The configuration is provided via a closure that receives a cache config builder.

Parameters

• config_fn: Closure for configuring the cache module

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_auth_module<F>(self, config_fn: F) -> Self

where F: FnOnce(&mut RiAuthConfig) -> &mut RiAuthConfig,

Add authentication module with configuration.

This method adds an authentication module to the application with custom configuration.

Parameters

• config_fn: Closure for configuring the auth module

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_queue_module<F>(self, config_fn: F) -> Self

where F: FnOnce(&mut RiQueueConfig) -> &mut RiQueueConfig,

Add queue module with configuration.

This method adds a message queue module to the application with custom configuration.

Parameters

• config_fn: Closure for configuring the queue module

Returns

The updated RiAppBuilder instance for method chaining.

pub fn with_device_module<F>(self, config_fn: F) -> Self

where F: FnOnce(&mut RiDeviceControlConfig) -> &mut RiDeviceControlConfig,

Add device control module with configuration.

This method adds a device control module to the application with custom configuration.

Parameters

• config_fn: Closure for configuring the device module

Returns

The updated RiAppBuilder instance for method chaining.

pub fn build(self) -> RiResult<RiAppRuntime>

Build the application runtime.

This method performs the following steps:

1. Creates and configures the configuration manager
2. Loads configuration from specified files and environment variables
3. Creates the service context with core functionalities
4. Adds core modules (analytics and lifecycle observer)
5. Sorts modules based on dependencies and priority
6. Creates and returns the application runtime

Returns

A RiResult containing the built RiAppRuntime instance, or an error if building fails.

Errors

• If configuration loading fails
• If service context creation fails
• If module sorting fails due to circular dependencies

Trait Implementations

impl Default for RiAppBuilder

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for RiAppBuilder

type Target = RiAppBuilder

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiAppBuilder

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 = /// ```

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<RiAppBuilder>

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 RiAppBuilder

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

impl PyMethods<RiAppBuilder> for PyClassImplCollector<RiAppBuilder>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiAppBuilder

const NAME: &'static str = "RiAppBuilder"

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 RiAppBuilder

impl ExtractPyClassWithClone for RiAppBuilder