1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

// Copyright 2017 Maskerad Developers
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

//! This library provides 2 object pools :
//!
//! - An object pool for single threaded scenarios.
//!
//! - An object pool for multi threaded scenarios.
//!
//! An object pool is a collection of reusable objects, which are allocated in advance.
//! We can ask an object if he's "alive".
//!
//! When the pool is initialized, it creates the entire collection of objects and initialize them
//! to the "not in use" state.
//!
//! When you want a new object, you ask the pool to give the first "not in use" object.
//! When you no longer need the object, the object goes back to the "not in use" state.
//!
//! From the user's perspective, he creates(allocate) and destroys/drops(deallocate) objects, but no
//! allocations occur.


mod refcounted_pool_allocator;
mod concurrent_pool_allocator;
mod concurrent_pool_handler;
mod refcounted_pool_handler;
mod pool_object;
mod errors;

pub use refcounted_pool_allocator::RefCountedObjectPool as ObjectPool;
pub use concurrent_pool_allocator::ConcurrentObjectPool as AtomicObjectPool;
pub use refcounted_pool_handler::PoolObjectHandler as Handler;
pub use concurrent_pool_handler::ConcurrentPoolObjectHandler as AtomicHandler;
pub use errors::PoolError;
pub use pool_object::PoolObject;
pub use errors::PoolResult;