roopes-core 0.1.1

Roopes is a Rust Object Oriented Pattern Element System. This crate provides generic traits and implementations for typical object-oriented patterns in Rust. It is intended to be used as a cluster of utility classes for implementing OOP-architected executables -- in Rust!
Documentation 
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
41

//!
#![cfg_attr(feature = "doc-images",
  cfg_attr(
    all(),
    doc = ::embed_doc_image::embed_image!(
        "heap-pool-diagram",
        "src/patterns/heap_pool/heap_pool.svg"
)))]
//! Contains types which allow client code to
//! generate, use, and re-use heap-allocated
//! objects efficiently.
//!
//! ![heap pool diagram][heap-pool-diagram]

pub mod refcell_box;

#[cfg(test)]
mod tests;

/// Holds a list of allocated objects in a
/// scalable pool.  Previously allocated
/// objects can be checked back in after use, to
/// prevent immediate deallocation.
pub trait HeapPool<C>
{
    /// Get a value from the [`HeapPool`].
    fn check_out(&mut self) -> C;

    /// Give a value back to the [`HeapPool`].
    fn check_in(
        &mut self,
        container: C,
    );
}

/// Exposes the [`HeapPool`] types at the library
/// level.
pub mod prelude
{
    pub use super::HeapPool;
}