https://github.com/zxch3n/append-only-bytes

https://github.com/zxch3n/append-only-bytes

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/zxch3n/append-only-bytes
• Owner: zxch3n
• License: mit
• Created: 2022-12-05T17:44:57.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-10-28T05:34:11.000Z (about 1 year ago)
• Last Synced: 2024-10-04T16:22:11.288Z (3 months ago)
• Language: Rust
• Size: 24.4 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


append-only-bytes

  
Documentation

  





If an array is append-only and guarantees that all the existing data is immutable, we can safely share slices of this array across threads, while the owner can still safely append new data to it.

This is safe because no mutable byte has more than one owner. If there isn't enough capacity for a new append, `AppendOnlyBytes` will not deallocate the old memory if a `ByteSlice` is referring to it. The old memory will be deallocated only when all the `ByteSlice`s referring to it are dropped.

# Example

```rust

use append_only_bytes::{AppendOnlyBytes, BytesSlice};

let mut bytes = AppendOnlyBytes::new();

bytes.push_slice(&[1, 2, 3]);

let slice: BytesSlice = bytes.slice(1..);

bytes.push_slice(&[4, 5, 6]);

assert_eq!(&*slice, &[2, 3]);

assert_eq!(bytes.as_bytes(), &[1, 2, 3, 4, 5, 6])

```

# Features

- `serde`: support serde serialization and deserialization

- `u32_range`: support `u32` range for `ByteSlices` method