Struct pavex::blueprint::constructor::Constructor

source ·
pub struct Constructor { /* private fields */ }
Expand description

A constructor that has been configured but has not yet been registered with a Blueprint.

§Guide

Check out the “Dependency injection” section of Pavex’s guide for a thorough introduction to dependency injection in Pavex applications.

§Use cases

Constructor is primarily used by kits (e.g. ApiKit) to allow users to customize (or disable!) the bundled constructors before registering them with a Blueprint.

Implementations§

source§

impl Constructor

source

pub fn new(callable: RawIdentifiers, lifecycle: Lifecycle) -> Self

Create a new (unregistered) constructor.

Check out the documentation of Blueprint::constructor for more details on constructors.

source

pub fn singleton(callable: RawIdentifiers) -> Self

Create a new (unregistered) constructor with a singleton lifecycle.

It’s a shorthand for Constructor::new(callable, Lifecycle::Singleton).

source

pub fn request_scoped(callable: RawIdentifiers) -> Self

Create a new (unregistered) constructor with a request-scoped lifecycle.

It’s a shorthand for Constructor::new(callable, Lifecycle::RequestScoped).

source

pub fn transient(callable: RawIdentifiers) -> Self

Create a new (unregistered) constructor with a transient lifecycle.

It’s a shorthand for Constructor::new(callable, Lifecycle::Transient).

source

pub fn error_handler(self, error_handler: RawIdentifiers) -> Self

Register an error handler for this constructor.

Check out the documentation of RegisteredConstructor::error_handler for more details.

source

pub fn cloning(self, cloning_strategy: CloningStrategy) -> Self

Set the cloning strategy for the output type returned by this constructor.

Check out the documentation of CloningStrategy for more details.

source

pub fn clone_if_necessary(self) -> Self

Set the cloning strategy to CloningStrategy::CloneIfNecessary.
Check out Constructor::cloning for more details.

source

pub fn never_clone(self) -> Self

Set the cloning strategy to CloningStrategy::NeverClone.
Check out Constructor::cloning for more details.

source

pub fn ignore(self, lint: Lint) -> Self

Tell Pavex to ignore a specific Lint when analysing this constructor and the way it’s used.

source

pub fn enforce(self, lint: Lint) -> Self

Tell Pavex to enforce a specific Lint when analysing this constructor and the way it’s used.

source

pub fn register(self, bp: &mut Blueprint) -> RegisteredConstructor<'_>

Register this constructor with a Blueprint.

Check out the documentation of Blueprint::constructor for more details.

Trait Implementations§

source§

impl Clone for Constructor

source§

fn clone(&self) -> Constructor

Returns a copy 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 Debug for Constructor

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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