pub struct DMSCServiceContext { /* private fields */ }Expand description
Public-facing service context for DMSC applications.
The DMSCServiceContext is the primary way for modules and business logic to
access core DMSC 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 dmsc::prelude::*;
async fn handle_request(ctx: &DMSCServiceContext) -> DMSCResult<()> {
// 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§
Source§impl DMSCServiceContext
impl DMSCServiceContext
Sourcepub fn new_with(
fs: DMSCFileSystem,
logger: DMSCLogger,
config: DMSCConfigManager,
hooks: DMSCHookBus,
metrics_registry: Option<Arc<DMSCMetricsRegistry>>,
) -> Self
pub fn new_with( fs: DMSCFileSystem, logger: DMSCLogger, config: DMSCConfigManager, hooks: DMSCHookBus, metrics_registry: Option<Arc<DMSCMetricsRegistry>>, ) -> Self
Create a new DMSCServiceContext 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 accessorlogger: Structured loggerconfig: Configuration managerhooks: Hook bus for lifecycle eventsmetrics_registry: Optional metrics registry for observability
§Returns
A new DMSCServiceContext instance.
Sourcepub fn new_default() -> DMSCResult<Self>
pub fn new_default() -> DMSCResult<Self>
Create a new DMSCServiceContext 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 DMSCResult 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
Sourcepub fn fs(&self) -> &DMSCFileSystem
pub fn fs(&self) -> &DMSCFileSystem
Sourcepub fn logger(&self) -> &DMSCLogger
pub fn logger(&self) -> &DMSCLogger
Sourcepub fn config(&self) -> Arc<DMSCConfigManager>
pub fn config(&self) -> Arc<DMSCConfigManager>
Get a reference to the configuration manager.
§Returns
A reference to the DMSCConfigManager instance.
Sourcepub fn hooks(&self) -> Arc<DMSCHookBus>
pub fn hooks(&self) -> Arc<DMSCHookBus>
Get a reference to the hook bus for emitting events.
§Returns
A reference to the DMSCHookBus instance.
Sourcepub fn hooks_mut(&mut self) -> &mut DMSCHookBus
pub fn hooks_mut(&mut self) -> &mut DMSCHookBus
Get a mutable reference to the hook bus for registering handlers.
§Returns
A mutable reference to the DMSCHookBus instance.
Sourcepub fn config_mut(&mut self) -> &mut DMSCConfigManager
pub fn config_mut(&mut self) -> &mut DMSCConfigManager
Get a mutable reference to the configuration manager.
§Returns
A mutable reference to the DMSCConfigManager instance.
Sourcepub fn fs_mut(&mut self) -> &mut DMSCFileSystem
pub fn fs_mut(&mut self) -> &mut DMSCFileSystem
Get a mutable reference to the file system accessor.
§Returns
A mutable reference to to the DMSCFileSystem instance.
Sourcepub fn logger_mut(&mut self) -> &mut DMSCLogger
pub fn logger_mut(&mut self) -> &mut DMSCLogger
Get a mutable reference to the structured logger.
§Returns
A mutable reference to the DMSCLogger instance.
Sourcepub fn metrics_registry(&self) -> Option<Arc<DMSCMetricsRegistry>>
pub fn metrics_registry(&self) -> Option<Arc<DMSCMetricsRegistry>>
Get a reference to the metrics registry if available.
§Returns
An optional reference to the DMSCMetricsRegistry instance.
Trait Implementations§
Source§impl Clone for DMSCServiceContext
impl Clone for DMSCServiceContext
Source§fn clone(&self) -> DMSCServiceContext
fn clone(&self) -> DMSCServiceContext
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<'py> IntoPyObject<'py> for DMSCServiceContext
impl<'py> IntoPyObject<'py> for DMSCServiceContext
Source§type Target = DMSCServiceContext
type Target = DMSCServiceContext
Source§type Output = Bound<'py, <DMSCServiceContext as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <DMSCServiceContext as IntoPyObject<'py>>::Target>
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Source§impl PyClass for DMSCServiceContext
impl PyClass for DMSCServiceContext
Source§impl PyClassImpl for DMSCServiceContext
impl PyClassImpl for DMSCServiceContext
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
Source§const RAW_DOC: &'static CStr = c"Public-facing service context for DMSC applications.\n\nThe `DMSCServiceContext` is the primary way for modules and business logic to\naccess core DMSC 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 dmsc::prelude::*;\n\nasync fn handle_request(ctx: &DMSCServiceContext) -> DMSCResult<()> {\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"
const RAW_DOC: &'static CStr = c"Public-facing service context for DMSC applications.\n\nThe `DMSCServiceContext` is the primary way for modules and business logic to\naccess core DMSC 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 dmsc::prelude::*;\n\nasync fn handle_request(ctx: &DMSCServiceContext) -> DMSCResult<()> {\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"
Source§const DOC: &'static CStr
const DOC: &'static CStr
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<DMSCServiceContext>
type ThreadChecker = SendablePyClass<DMSCServiceContext>
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
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>
Source§impl PyClassNewTextSignature for DMSCServiceContext
impl PyClassNewTextSignature for DMSCServiceContext
const TEXT_SIGNATURE: &'static str = "()"
Source§impl PyMethods<DMSCServiceContext> for PyClassImplCollector<DMSCServiceContext>
impl PyMethods<DMSCServiceContext> for PyClassImplCollector<DMSCServiceContext>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for DMSCServiceContext
impl PyTypeInfo for DMSCServiceContext
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
object is an instance of this type or a subclass of this type.§fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
object is an instance of this type.impl DerefToPyAny for DMSCServiceContext
impl ExtractPyClassWithClone for DMSCServiceContext
Auto Trait Implementations§
impl Freeze for DMSCServiceContext
impl !RefUnwindSafe for DMSCServiceContext
impl Send for DMSCServiceContext
impl Sync for DMSCServiceContext
impl Unpin for DMSCServiceContext
impl !UnwindSafe for DMSCServiceContext
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
self into an owned Python object, dropping type information.§fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>
fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>
self into an owned Python object, dropping type information and unbinding it
from the 'py lifetime.§fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>
fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>
self into a Python object. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
§fn type_check(object: &Bound<'_, PyAny>) -> bool
fn type_check(object: &Bound<'_, PyAny>) -> bool
§fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>
fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>
isinstance and issubclass function. Read more