DMSCServiceContext

Struct DMSCServiceContext 

Source
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

Source

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 accessor
  • logger: Structured logger
  • config: Configuration manager
  • hooks: Hook bus for lifecycle events
  • metrics_registry: Optional metrics registry for observability
§Returns

A new DMSCServiceContext instance.

Source

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
Source

pub fn fs(&self) -> &DMSCFileSystem

Get a reference to the file system accessor.

§Returns

A reference to the DMSCFileSystem instance.

Source

pub fn logger(&self) -> &DMSCLogger

Get a reference to the structured logger.

§Returns

A reference to the DMSCLogger instance.

Source

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

Get a reference to the configuration manager.

§Returns

A reference to the DMSCConfigManager instance.

Source

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

Get a reference to the hook bus for emitting events.

§Returns

A reference to the DMSCHookBus instance.

Source

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.

Source

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

Get a mutable reference to the configuration manager.

§Returns

A mutable reference to the DMSCConfigManager instance.

Source

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.

Source

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

Get a mutable reference to the structured logger.

§Returns

A mutable reference to the DMSCLogger instance.

Source

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

Source§

fn clone(&self) -> DMSCServiceContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'py> IntoPyObject<'py> for DMSCServiceContext

Source§

type Target = DMSCServiceContext

The Python output type
Source§

type Output = Bound<'py, <DMSCServiceContext as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.
Source§

impl PyClass for DMSCServiceContext

Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for DMSCServiceContext

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
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"

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<DMSCServiceContext>

This handles following two situations: Read more
Source§

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable
Source§

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.
Source§

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.
Source§

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.
Source§

fn items_iter() -> PyClassItemsIter

Source§

fn lazy_type_object() -> &'static LazyTypeObject<Self>

§

fn dict_offset() -> Option<isize>

§

fn weaklist_offset() -> Option<isize>

Source§

impl PyClassNewTextSignature for DMSCServiceContext

Source§

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

Source§

impl PyMethods<DMSCServiceContext> for PyClassImplCollector<DMSCServiceContext>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for DMSCServiceContext

Source§

const NAME: &'static str = "DMSCServiceContext"

Class name.
Source§

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.
Source§

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.
Source§

impl DerefToPyAny for DMSCServiceContext

Source§

impl ExtractPyClassWithClone for DMSCServiceContext

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<'a, 'py, T> FromPyObject<'a, 'py> for T
where T: PyClass + Clone + ExtractPyClassWithClone,

§

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error. Read more
§

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<T, <T as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj. Read more
§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

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

Converts self into a Python object. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = T::NAME

👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.
§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<'py, T> FromPyObjectOwned<'py> for T
where T: for<'a> FromPyObject<'a, 'py>,

§

impl<T> Ungil for T
where T: Send,