ration 0.2.1

A shared memory library
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
42

//! Ration
//!
//! A simple, easy-to-use, shared memory library.
//!
//! # Getting Started
//!
//! It's best to start by looking through the [examples directory](https://github.com/rtthw/ration/tree/master/examples).
//!
//! # Note on allocating/opening paths.
//!
//! If the path you provide to `alloc` or `open` for some data type, `ration` will attempt to
//! place your data structure into `/dev/shm/`.



pub mod array;
pub mod block;

pub use array::*;
pub use block::*;



pub type Result<T> = std::result::Result<T, Error>;

#[derive(Debug)]
pub enum Error {
    /// Generic shared memory error.
    Shm(shared_memory::ShmemError),
    /// Expected a different block size from the one that was given.
    InvalidBlockSize,
    /// Attempted to allocated a block that has already been allocated.
    BlockAlreadyAllocated,
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self)
    }
}

impl std::error::Error for Error {}