Skip to main content

Provider

Struct Provider 

Source
pub struct Provider;
Expand description

Provider Helper Struct

A helper struct for creating different types of providers. Use the static methods Provider::value(), Provider::factory(), Provider::request_factory(), and Provider::transient_factory() when defining module providers or registering them manually.

§Example

impl ModuleDefinition for AppModule {
    fn register(container: &Container) -> Result<()> {
        register_provider(container, Provider::value(AppConfig::default()))?;
        register_provider(container, Provider::factory(|c| Ok(MyService::new(c))))?;
        Ok(())
    }
}

Implementations§

Source§

impl Provider

Source

pub fn value<T>(value: T) -> ValueProvider<T>
where T: Send + Sync + 'static,

Creates a value provider from an existing value.

The value will be registered as a singleton in the container.

§Type Parameters
  • T: The type to register (must be Send + Sync + ’static)
§Arguments
  • value: The value to register as a singleton
Source

pub fn factory<T, F>(factory: F) -> FactoryProvider<T, F>
where T: Send + Sync + 'static, F: FnOnce(&Container) -> Result<T> + Send + 'static,

Creates a factory provider.

The factory receives the Container and returns Result. It is executed immediately when the module registers its providers. The result is stored as a singleton.

§Type Parameters
  • T: The type to create (must be Send + Sync + ’static)
  • F: The factory function type
Source

pub fn request_factory<T, F>(factory: F) -> RequestFactoryProvider<T, F>
where T: Send + Sync + 'static, F: Fn(&Container) -> Result<T> + Send + Sync + 'static,

Creates a request-scoped provider.

The factory is executed once per request (per scoped container). The created instance is cached for the duration of that request.

§Type Parameters
  • T: The type to create (must be Send + Sync + ’static)
  • F: The factory function type
Source

pub fn transient_factory<T, F>(factory: F) -> TransientFactoryProvider<T, F>
where T: Send + Sync + 'static, F: Fn(&Container) -> Result<T> + Send + Sync + 'static,

Creates a transient provider.

The factory is executed every time the type is resolved via container.resolve(). A new instance is created each time.

§Type Parameters
  • T: The type to create (must be Send + Sync + ’static)
  • F: The factory function type

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
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> IntoInjectableResult<T> for T

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

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,