#random-access #memory-access #read-write #offset #length #memory-storage #continuously

random-access-memory

Continuously read and write to memory using random offsets and lengths

14 releases (5 stable)

3.0.0 Apr 12, 2023
2.0.0 Mar 3, 2020
1.2.0 Mar 3, 2020
1.0.0 Apr 24, 2019
0.1.0 Mar 21, 2018

#5 in #random-access

Download history 2/week @ 2023-11-20 5/week @ 2023-11-27 267/week @ 2023-12-04 65/week @ 2023-12-11 7/week @ 2024-01-01 268/week @ 2024-01-08 77/week @ 2024-01-15 69/week @ 2024-02-12 29/week @ 2024-02-19 60/week @ 2024-02-26 21/week @ 2024-03-04

179 downloads per month
Used in 4 crates

MIT/Apache

18KB
202 lines

random-access-memory

crates.io version build status downloads docs.rs docs

Continuously read and write to memory using random offsets and lengths using abstract interface defined in random-access-storage.

Installation

$ cargo add random-access-memory

License

MIT OR Apache-2.0


lib.rs:

Continuously read and write to memory using random offsets and lengths

[RandomAccessMemory] is a complete implementation of random-access-storage for in-memory storage.

See also random-access-disk for on-disk storage that can be swapped with this.

Examples

Reading, writing, deleting and truncating:

use random_access_storage::RandomAccess;
use random_access_memory::RandomAccessMemory;

let mut storage = RandomAccessMemory::default();
storage.write(0, b"hello").await.unwrap();
storage.write(5, b" world").await.unwrap();
assert_eq!(storage.read(0, 11).await.unwrap(), b"hello world");
assert_eq!(storage.len().await.unwrap(), 11);
storage.del(5, 2).await.unwrap();
assert_eq!(storage.read(5, 2).await.unwrap(), [0, 0]);
assert_eq!(storage.len().await.unwrap(), 11);
storage.truncate(2).await.unwrap();
assert_eq!(storage.len().await.unwrap(), 2);
storage.truncate(5).await.unwrap();
assert_eq!(storage.len().await.unwrap(), 5);
assert_eq!(storage.read(0, 5).await.unwrap(), [b'h', b'e', 0, 0, 0]);

In order to get benefits from the swappable interface, you will in most cases want to use generic functions for storage manipulation:

use random_access_storage::RandomAccess;
use random_access_memory::RandomAccessMemory;
use std::fmt::Debug;

let mut storage = RandomAccessMemory::default();
write_hello_world(&mut storage).await;
assert_eq!(read_hello_world(&mut storage).await, b"hello world");

/// Write with swappable storage
async fn write_hello_world<T>(storage: &mut T)
where T: RandomAccess + Debug + Send,
{
  storage.write(0, b"hello").await.unwrap();
  storage.write(5, b" world").await.unwrap();
}

/// Read with swappable storage
async fn read_hello_world<T>(storage: &mut T) -> Vec<u8>
where T: RandomAccess + Debug + Send,
{
  storage.read(0, 11).await.unwrap()
}

Dependencies

~0.4–0.8MB
~19K SLoC