Struct Guard 

pub struct Guard<T> { /* private fields */ }

A handle to a value from the pool

When the Guard is dropped, the value is returned to the pool

Examples

use tub::{Pool, Guard};

#[tokio::main]
async fn main() {
  // Create a pool of u32 values
  let pool: Pool<u32> = Pool::from_default(10);

  // Get a value from the pool
  let mut value: Guard<u32> = pool.acquire().await;
   
  // Return the value to the pool
  drop(value);
}

Trait Implementations

impl<T> Deref for Guard<T>

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

Examples

use tub::Pool;

#[tokio::main]
async fn main() {
  let pool: Pool<u32> = Pool::from_vec(vec![0]);
  let mut box1 = pool.acquire().await;

  // Read the value
  assert_eq!(*box1, 0);
}

type Target = T

The resulting type after dereferencing.

impl<T> DerefMut for Guard<T>

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

Examples

use tub::Pool;

#[tokio::main]
async fn main() {
  let pool: Pool<u32> = Pool::from_vec(vec![0]);
  let mut value = pool.acquire().await;
  assert_eq!(*value, 0);

  // Mutate the value
  *value = 123;
  assert_eq!(*value, 123);
}

impl<T> Drop for Guard<T>

fn drop(&mut self)

Examples

use tub::Pool;

#[tokio::main]
async fn main() {
  let pool: Pool<u32> = Pool::from_default(1);
  assert_eq!(pool.remaining_capacity(), 1);
  let mut value = pool.acquire().await;

  // Return the value to the pool
  drop(value);
  assert_eq!(pool.remaining_capacity(), 1);
}