Crate load_balancer

Crate load_balancer 

Source
Expand description

§Load Balancer Library

This library provides a set of generic load balancer implementations for distributing workloads across multiple targets, such as clients, network endpoints, or resources.

§Traits

§LoadBalancer<T>

A generic trait for asynchronous or synchronous load balancing. Implementors provide methods to allocate a resource from the pool.

use std::future::Future;

pub trait LoadBalancer<T>: Send + Sync + Clone + 'static {
    /// Asynchronously allocate a resource.
    /// Returns `Some(T)` if successful, or `None` if no resource is available.
    fn alloc(&self) -> impl Future<Output = Option<T>> + Send;

    /// Attempt to allocate a resource synchronously without awaiting.
    /// Returns `Some(T)` if successful, or `None` if no resource is available.
    fn try_alloc(&self) -> Option<T>;
}

§BoxLoadBalancer<T>

An async trait variant that can be used with async_trait for boxed trait objects or dynamic dispatch. Provides similar functionality to LoadBalancer but supports fully async method signatures.

use async_trait::async_trait;

#[async_trait]
pub trait BoxLoadBalancer<T>: Send + Sync + Clone + 'static {
    /// Asynchronously allocate a resource.
    /// Returns `Some(T)` if successful, or `None` if no resource is available.
    async fn alloc(&self) -> Option<T>;

    /// Attempt to allocate a resource synchronously without awaiting.
    /// Returns `Some(T)` if successful, or `None` if no resource is available.
    fn try_alloc(&self) -> Option<T>;
}

§Notes

  • All load balancers are Send, Sync, and Clone, making them suitable for multi-threaded asynchronous environments.
  • The alloc method returns Option<T> rather than Result, reflecting that allocation failure is expected under normal conditions and not necessarily an error.
  • try_alloc is non-blocking and will return None immediately if no resource is available.

Re-exports§

pub use anyhow;
pub use get_if_addrs;

Modules§

interval
ip
limit
random
simple
threshold

Traits§

BoxLoadBalancer
LoadBalancer