Struct sgdata::SGData

pub struct SGData(_);

Scattered, gathered, immutable, arc-ed data

Allows zero-copy processing of streamed data, read into fixed-size buffers. Especially useful for high-performance, parallel data processing.

A piece of data potentially scattered between multiple parts, which themselves might be slices of shared-ownership underlying data.

SGData is essentially semantic wrapper over Vec<ArcRef<Vec<u8>, [u8]>>

For illustration:

frames:      [    Buf    ][    Buf    ][    Buf    ][    Buf    ]
edges:       |                |    |                      |     |
             |                |    |                      |     |
              \          /\  / \  / \ /\           /\    / \   /
               \        /  ||   ||  | | \         /  \  /   \ /
sgdata parts:      C1[0] C1[1] C2[0] C3[0]   C3[1]   C3[2]  C4[0]

Arbitrary-sized data is being read into frames and edges between logical parts are being found. Then sgdata objects are created, aggregating parts of frames while holding reference-counted shared ownership over frames.

Implementations

impl SGData

pub fn empty() -> Self

pub fn from_single(v: Vec<u8>) -> Self

pub fn from_vec(v: Vec<ArcRef<Vec<u8>, [u8]>>) -> Self

pub fn from_many(v: Vec<Vec<u8>>) -> Self

pub fn len(&self) -> usize

Total len of all parts

pub fn is_empty(&self) -> bool

pub fn as_parts(&self) -> &[ArcRef<Vec<u8>, [u8]>]

pub fn as_vec(&self) -> &Vec<ArcRef<Vec<u8>, [u8]>>

pub fn as_vec_mut(&mut self) -> &mut Vec<ArcRef<Vec<u8>, [u8]>>

pub fn push_vec(&mut self, v: Vec<u8>)

pub fn push_arcref(&mut self, arcref: ArcRef<Vec<u8>, [u8]>)

pub fn to_linear(&self) -> ArcRef<Vec<u8>, [u8]>

Convert to linear (single vector) form

If self is empty or already contains only one piece, this is cheap.

If self is scattered between many pices, this requires copying all the data into a new, big chunk.

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

Trait Implementations

impl Clone for SGData

fn clone(&self) -> SGData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SGData

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

Formats the value using the given formatter.

impl PartialEq<SGData> for SGData

fn eq(&self, other: &SGData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SGData) -> bool

This method tests for !=.

impl Eq for SGData

impl StructuralEq for SGData

impl StructuralPartialEq for SGData