Trait shuttle_runtime::ResourceBuilder

pub trait ResourceBuilder<T> {
    type Config: Serialize;
    type Output: Serialize + DeserializeOwned;

    const TYPE: Type;

    // Required methods
    fn new() -> Self;
    fn config(&self) -> &Self::Config;
    fn output<'life0, 'async_trait>(
        self,
        factory: &'life0 mut dyn Factory
    ) -> Pin<Box<dyn Future<Output = Result<Self::Output, Error>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: 'async_trait;
    fn build<'life0, 'async_trait>(
        build_data: &'life0 Self::Output
    ) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: 'async_trait;
}

Used to get resources of type T from factories.

This is mainly meant for consumption by our code generator and should generally not be called by users.

Creating your own managed resource

You may want to create your own managed resource by implementing this trait for some builder B to construct resource T. Factory can be used to provision resources on Shuttle’s servers if your service will need any.

Please refer to shuttle-examples/custom-resource for examples of how to create custom resource. For more advanced provisioning of custom resources, please get in touch and detail your use case. We’ll be interested to see what you want to provision and how to do it on your behalf on the fly.

Required Associated Types

type Config: Serialize

The internal config being constructed by this builder. This will be used to find cached Self::Output.

type Output: Serialize + DeserializeOwned

The output type used to build this resource later

Required Associated Constants

const TYPE: Type

The type of resource this creates

Required Methods

fn new() -> Self

Create a new instance of this resource builder

fn config(&self) -> &Self::Config

Get the internal config state of the builder

If the exact same config was returned by a previous deployment that used this resource, then Self::output() will not be called to get the builder output again. Rather the output state of the previous deployment will be passed to Self::build().

fn output<'life0, 'async_trait>( self, factory: &'life0 mut dyn Factory ) -> Pin<Box<dyn Future<Output = Result<Self::Output, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Get the config output of this builder

This method is where the actual resource provisioning should take place and is expected to take the longest. It can at times even take minutes. That is why the output of this method is cached and calling this method can be skipped as explained in Self::config().

fn build<'life0, 'async_trait>( build_data: &'life0 Self::Output ) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Build this resource from its config output

Object Safety

This trait is not object safe.

Implementors