Skip to main content

SharedFrame

Enum SharedFrame 

Source
pub enum SharedFrame {
    Owned(Vec<u8>),
    Shared(Arc<Vec<u8>>),
}
Expand description

A raw-bytes frame that may be shared (zero-copy) or exclusively owned.

Adjacent nodes that produce and consume the same format can pass a SharedFrame::Shared variant through the graph; the receiving node reads the bytes via SharedFrame::as_bytes without any memcpy. When a node must mutate the payload it calls SharedFrame::into_owned, which clones the bytes only when there is more than one live Arc reference.

Variants§

§

Owned(Vec<u8>)

Exclusively-owned byte buffer.

§

Shared(Arc<Vec<u8>>)

Reference-counted (shared) byte buffer — zero-copy on the read path.

Implementations§

Source§

impl SharedFrame

Source

pub fn as_bytes(&self) -> &[u8]

Borrow the underlying bytes regardless of ownership variant.

Source

pub fn into_owned(self) -> Vec<u8>

Consume into an exclusively-owned Vec<u8>.

  • Owned — free, no allocation.
  • Shared with a unique reference — moves the inner Vec out of the Arc without copying.
  • Shared with multiple references — clones the bytes once.
Source

pub fn try_share(&self) -> Arc<Vec<u8>>

Return an Arc<Vec<u8>> that points at the same allocation as self.

  • Shared — clones the Arc (O(1), no heap allocation).
  • Owned — wraps the buffer in a new Arc (one allocation, O(1)).
Source

pub fn promote(self) -> Self

Promote an Owned frame to Shared, consuming self.

If already Shared, returns self unchanged.

Source

pub fn is_shared(&self) -> bool

Returns true if this is the Shared variant.

Source

pub fn is_owned(&self) -> bool

Returns true if this is the Owned variant.

Trait Implementations§

Source§

impl Clone for SharedFrame

Source§

fn clone(&self) -> SharedFrame

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SharedFrame

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl From<Arc<Vec<u8>>> for SharedFrame

Source§

fn from(arc: Arc<Vec<u8>>) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<u8>> for SharedFrame

Source§

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.