Skip to content
This repository has been archived by the owner on Feb 18, 2024. It is now read-only.

Commit

Permalink
Improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgecarleitao committed Jul 13, 2022
1 parent a8b526f commit ef8aeab
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions src/buffer/immutable.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@ use std::{iter::FromIterator, ops::Deref, sync::Arc, usize};

use super::Bytes;

/// [`Buffer`] is a contiguous memory region of plain old data types
/// that can be shared across thread boundaries.
/// [`Buffer`] is a contiguous memory region that can be shared across
/// thread boundaries.
///
/// The easiest way to think about [`Buffer<T>`] is being equivalent to
/// a `Arc<Vec<T>>`, with the following differences:
/// * `T` must be [`NativeType`]
/// * slicing and cloning is `O(1)`.
/// * it supports external allocated memory (via FFI)
/// * it supports external allocated memory
///
/// The easiest way to create one is to use its implementation of `From<Vec<T>>`.
///
Expand Down

0 comments on commit ef8aeab

Please sign in to comment.