Struct options::OptionsBuilder

pub struct OptionsBuilder<'a, T: 'static> { /* private fields */ }

Available on crate feature di only.

Represents a builder used to configure Options.

Implementations

impl<'a, T: 'static> OptionsBuilder<'a, T>

pub fn new(services: &'a mut ServiceCollection, name: Option<&str>) -> Self

Initializes a new options builder.

Arguments

• services - The associated collection of services
• name - The optional name associated with the options

pub fn name(&self) -> Option<&str>

Gets the name of the options

pub fn services(&mut self) -> &mut ServiceCollection

Gets the associated collection of services

pub fn configure<F>(self, setup: F) -> Self

where F: Fn(&mut T) + 'static,

Registers an action used to configure a particular type of Options.

Arguments

• setup - The configuration action

pub fn configure1<F, D>(self, setup: F) -> Self

where F: Fn(&mut T, Ref<D>) + 'static, D: 'static,

Registers an action used to configure a particular type of Options with a single dependency.

Arguments

• setup - The configuration action

pub fn configure2<F, D1, D2>(self, setup: F) -> Self

where F: Fn(&mut T, Ref<D1>, Ref<D2>) + 'static, D1: 'static, D2: 'static,

Registers an action used to configure a particular type of Options with two dependencies.

Arguments

• setup - The configuration action

pub fn configure3<F, D1, D2, D3>(self, setup: F) -> Self

where F: Fn(&mut T, Ref<D1>, Ref<D2>, Ref<D3>) + 'static, D1: 'static, D2: 'static, D3: 'static,

Registers an action used to configure a particular type of Options with three dependencies.

Arguments

• setup - The configuration action

pub fn configure4<F, D1, D2, D3, D4>(self, setup: F) -> Self

where F: Fn(&mut T, Ref<D1>, Ref<D2>, Ref<D3>, Ref<D4>) + 'static, D1: 'static, D2: 'static, D3: 'static, D4: 'static,

Registers an action used to configure a particular type of Options with four dependencies.

Arguments

• setup - The configuration action

pub fn configure5<F, D1, D2, D3, D4, D5>(self, setup: F) -> Self

where F: Fn(&mut T, Ref<D1>, Ref<D2>, Ref<D3>, Ref<D4>, Ref<D5>) + 'static, D1: 'static, D2: 'static, D3: 'static, D4: 'static, D5: 'static,

Registers an action used to configure a particular type of Options with five dependencies.

Arguments

• setup - The configuration action

pub fn post_configure<F>(self, setup: F) -> Self

where F: Fn(&mut T) + 'static,

Registers an action used to configure a particular type of Options.

Arguments

• setup - The configuration action

pub fn post_configure1<F, D>(self, setup: F) -> Self

where F: Fn(&mut T, Ref<D>) + 'static, D: 'static,

Registers an action used to configure a particular type of Options with a single dependency.

Arguments

• setup - The configuration action

pub fn post_configure2<F, D1, D2>(self, setup: F) -> Self

where F: Fn(&mut T, Ref<D1>, Ref<D2>) + 'static, D1: 'static, D2: 'static,

Registers an action used to configure a particular type of Options with two dependencies.

Arguments

• setup - The configuration action

pub fn post_configure3<F, D1, D2, D3>(self, setup: F) -> Self

where F: Fn(&mut T, Ref<D1>, Ref<D2>, Ref<D3>) + 'static, D1: 'static, D2: 'static, D3: 'static,

Registers an action used to configure a particular type of Options with three dependencies.

Arguments

• setup - The configuration action

pub fn post_configure4<F, D1, D2, D3, D4>(self, setup: F) -> Self

where F: Fn(&mut T, Ref<D1>, Ref<D2>, Ref<D3>, Ref<D4>) + 'static, D1: 'static, D2: 'static, D3: 'static, D4: 'static,

Registers an action used to configure a particular type of Options with four dependencies.

Arguments

• setup - The configuration action

pub fn post_configure5<F, D1, D2, D3, D4, D5>(self, setup: F) -> Self

where F: Fn(&mut T, Ref<D1>, Ref<D2>, Ref<D3>, Ref<D4>, Ref<D5>) + 'static, D1: 'static, D2: 'static, D3: 'static, D4: 'static, D5: 'static,

Registers an action used to configure a particular type of Options with five dependencies.

Arguments

• setup - The configuration action

pub fn validate<F, M>(self, action: F, failure_message: M) -> Self

where F: Fn(&T) -> bool + 'static, M: AsRef<str>,

Registers an action used to validate a particular type of Options.

Arguments

• action - The validation action
• failure_message - The message used when validation fails

pub fn validate1<F, M, D>(self, action: F, failure_message: M) -> Self

where F: Fn(&T, Ref<D>) -> bool + 'static, M: AsRef<str>, D: 'static,

Registers an action used to validate a particular type of Options with a single dependency.

Arguments

• action - The validation action
• failure_message - The message used when validation fails

pub fn validate2<F, M, D1, D2>(self, action: F, failure_message: M) -> Self

where F: Fn(&T, Ref<D1>, Ref<D2>) -> bool + 'static, M: AsRef<str>, D1: 'static, D2: 'static,

Registers an action used to validate a particular type of Options with two dependencies.

Arguments

• action - The validation action
• failure_message - The message used when validation fails

pub fn validate3<F, M, D1, D2, D3>(self, action: F, failure_message: M) -> Self

where F: Fn(&T, Ref<D1>, Ref<D2>, Ref<D3>) -> bool + 'static, M: AsRef<str>, D1: 'static, D2: 'static, D3: 'static,

Registers an action used to validate a particular type of Options with three dependencies.

Arguments

• action - The validation action
• failure_message - The message used when validation fails

pub fn validate4<F, M, D1, D2, D3, D4>( self, action: F, failure_message: M ) -> Self

where F: Fn(&T, Ref<D1>, Ref<D2>, Ref<D3>, Ref<D4>) -> bool + 'static, M: AsRef<str>, D1: 'static, D2: 'static, D3: 'static, D4: 'static,

Registers an action used to validate a particular type of Options with four dependencies.

Arguments

• action - The validation action
• failure_message - The message used when validation fails

pub fn validate5<F, M, D1, D2, D3, D4, D5>( self, action: F, failure_message: M ) -> Self

where F: Fn(&T, Ref<D1>, Ref<D2>, Ref<D3>, Ref<D4>, Ref<D5>) -> bool + 'static, M: AsRef<str>, D1: 'static, D2: 'static, D3: 'static, D4: 'static, D5: 'static,

Registers an action used to validate a particular type of Options with five dependencies.

Arguments

• action - The validation action
• failure_message - The message used when validation fails

Methods from Deref<Target = ServiceCollection>

pub fn is_empty(&self) -> bool

Returns true if the collection contains no elements.

pub fn len(&self) -> usize

Returns the number of elements in the collection.

pub fn clear(&mut self)

Removes all elements from the collection.

pub fn remove(&mut self, index: usize) -> ServiceDescriptor

Removes and returns the element at position index within the collection.

Argument

• index - The index of the element to remove

Panics

Panics if index is out of bounds.

pub fn add<T>(&mut self, descriptor: T) -> &mut ServiceCollection

where T: Into<ServiceDescriptor>,

Adds a service using the specified service descriptor.

Arguments

• descriptor - The ServiceDescriptor to register

pub fn try_add<T>(&mut self, descriptor: T) -> &mut ServiceCollection

where T: Into<ServiceDescriptor>,

Adds a service using the specified service descriptor if the service has not already been registered.

Arguments

• descriptor - The ServiceDescriptor to register

pub fn try_add_to_all<T>(&mut self, descriptor: T) -> &mut ServiceCollection

where T: Into<ServiceDescriptor>,

Adds a service using the specified service descriptor if the service with same service and implementation type has not already been registered.

Arguments

• descriptor - The ServiceDescriptor to register

pub fn try_add_all( &mut self, descriptors: impl IntoIterator<Item = ServiceDescriptor> ) -> &mut ServiceCollection

Adds the specified service descriptors if each of the services are not already registered with the same service and implementation type.

Arguments

• descriptors - The ServiceDescriptor sequence to register

pub fn replace<T>(&mut self, descriptor: T) -> &mut ServiceCollection

where T: Into<ServiceDescriptor>,

Removes the first service descriptor with the same service type and adds the replacement.

Arguments

• descriptor - The replacement ServiceDescriptor

pub fn try_replace<T>(&mut self, descriptor: T) -> &mut ServiceCollection

where T: Into<ServiceDescriptor>,

Adds or replaces a service with the specified descriptor if the service has not already been registered.

Arguments

• descriptor - The replacement ServiceDescriptor

pub fn remove_all<T>(&mut self) -> &mut ServiceCollection

where T: Any + ?Sized,

Removes all specified descriptors of the specified type.

pub fn build_provider(&self) -> Result<ServiceProvider, ValidationError>

Builds and returns a new ServiceProvider.

pub fn iter( &self ) -> impl Iterator<Item = &ServiceDescriptor> + ExactSizeIterator + DoubleEndedIterator

Gets a read-only iterator for the collection

Trait Implementations

impl<'a, T> Deref for OptionsBuilder<'a, T>

type Target = ServiceCollection

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T> DerefMut for OptionsBuilder<'a, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T> Into<&'a mut ServiceCollection> for OptionsBuilder<'a, T>

fn into(self) -> &'a mut ServiceCollection

Converts this type into the (usually inferred) input type.