Trait Manager

pub trait Manager: Sync + Send {
    type Type: Send;
    type Error: Send;

    // Required methods
    fn create(
        &self,
    ) -> impl Future<Output = Result<Self::Type, Self::Error>> + Send;
    fn recycle(
        &self,
        obj: &mut Self::Type,
        metrics: &Metrics,
    ) -> impl Future<Output = RecycleResult<Self::Error>> + Send;

    // Provided method
    fn detach(&self, _obj: &mut Self::Type) { ... }
}

Manager responsible for creating new Objects or recycling existing ones.

Required Associated Types

type Type: Send

Type of Objects that this Manager creates and recycles.

type Error: Send

Error that this Manager can return when creating and/or recycling Objects.

Required Methods

fn create(&self) -> impl Future<Output = Result<Self::Type, Self::Error>> + Send

Creates a new instance of Manager::Type.

fn recycle( &self, obj: &mut Self::Type, metrics: &Metrics, ) -> impl Future<Output = RecycleResult<Self::Error>> + Send

Tries to recycle an instance of Manager::Type.

Errors

Returns Manager::Error if the instance couldn’t be recycled.

Provided Methods

fn detach(&self, _obj: &mut Self::Type)

Detaches an instance of Manager::Type from this Manager.

This method is called when using the Object::take() method for removing an Object from a Pool. If the Manager doesn’t hold any references to the handed out Objects then the default implementation can be used which does nothing.

Object Safety

This trait is not object safe.

Implementors