Struct PrebuiltType

pub struct PrebuiltType { /* private fields */ }

A state input 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

PrebuiltType is primarily used by kits to allow users to customize (or disable!) state inputs before registering them with a Blueprint.

Implementations

impl PrebuiltType

pub fn new(type_: RawIdentifiers) -> Self

Create a new (unregistered) state input.

Check out the documentation of Blueprint::prebuilt for more details on state inputs.

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

Set the cloning strategy for the state input type.

Check out the documentation of CloningStrategy for more details.

pub fn clone_if_necessary(self) -> Self

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

pub fn never_clone(self) -> Self

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

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

Register this state input with a Blueprint.

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

Trait Implementations

impl Clone for PrebuiltType

fn clone(&self) -> PrebuiltType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrebuiltType

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

Formats the value using the given formatter.