Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stabilize vtable api #558

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions src/bytes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ pub struct Bytes {
vtable: &'static Vtable,
}

pub(crate) struct Vtable {
/// Raw methods for managing memory inside byte
pub struct Vtable {
/// fn(data, ptr, len)
pub clone: unsafe fn(&AtomicPtr<()>, *const u8, usize) -> Bytes,
/// fn(data, ptr, len)
Expand Down Expand Up @@ -484,8 +485,14 @@ impl Bytes {
self.truncate(0);
}

// Creates a new `Bytes` from a raw pointer and a vtable.
///
/// The returned `Bytes` will point directly to the given memory. There is
/// no allocating or copying.
/// # Safety
/// Unsafe because methods in vtable are unsafe
#[inline]
pub(crate) unsafe fn with_vtable(
pub unsafe fn with_vtable(
ptr: *const u8,
len: usize,
data: AtomicPtr<()>,
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ mod bytes;
mod bytes_mut;
mod fmt;
mod loom;
pub use crate::bytes::Bytes;
pub use crate::bytes::{Bytes, Vtable};
pub use crate::bytes_mut::BytesMut;

// Optional Serde support
Expand Down