Struct rexsgdata::SgData

pub struct SgData<O> where
    O: Clone,  { /* fields omitted */ }

High Level wrapper for multiple data representation methods. It has 2 fields:

1. data - a vector of heterogeneous data representations.

2. observers - An observer is some generic type that implements Clone.

   An observer can be explicitly associated with an sg-data By a call to the method observe() Or by the creation of a shallow copy of an observed sg-data, I.e. a call to the method copy_masked().

   An observer is used as a helper to ensure that an sg-data can safely be dropped, Since an Sg-Data is dropped with it's observers, they will not access it.

Methods

impl<O> SgData<O> where
    O: Clone, 

pub fn with_capacity(capcity: usize) -> Self

Create an SgData with specified capacity

pub fn iter(&self) -> impl Iterator<Item = &[u8]>

Iterates over all the underlying byte slices of this SgData.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut [u8]>

Iterates over all the mutable underlying byte slices of this SgData.

pub fn iter_masked<'a>(
    &'a self,
    mask: &'a Range<usize>
) -> impl Iterator<Item = &[u8]> + 'a

Given a mask iterates over slices that are visible after masking

pub fn size(&self) -> usize

Returns number of elements in the underlying object, NOT the total number of bytes.

pub fn capacity(&self) -> usize

Returns the total number of bytes in the underlying object.

pub fn is_empty(&self) -> bool

Checks this SgData for containing any byte slice

pub unsafe fn clone_into(self, iovec: *mut iovec, count: c_int) -> Self

Deprecated since 0.2.0:

use drain_into() instead

pub unsafe fn drain_into(self, iovec: *const iovec, count: usize) -> Self

Moves the data contained in this SgData instance into iovec. Consumes this instance and creates a new one, based on the buffers described by iovec and count.

observers are not drained since the data is moved to a new sg-list

pub fn to_vec(&self) -> Vec<u8>

Copies self into a Vector mask is an optional parameter: An exclusive range - i.e - from start to end - 1

pub fn clone_masked(&self, mask: Range<usize>) -> Self

Applies the mask to the current object and creates a new SgData object which describes only masked region observers are not cloned since this is a deep-copy cloning

pub fn copy_masked(&self, mask: Range<usize>) -> Self

Applies the mask to the current object and creates a new SgData object which describes only masked region observers are cloned since this is a shallow-copy clonning, and we want to make sure the data is not used-after-free.

pub fn is_iovec(&self) -> bool

Checks whether this instance is built from Iovec

pub fn is_sglist(&self) -> bool

Checks whether this instance is built from SgList

pub fn append(&mut self, other: &mut Self)

Deprecated since 0.2.2:

use Extend::extend() instead

pub fn zero(capacity: usize) -> Self

Creates an efficient (ZLE) zeroed buffer

pub fn observe(&mut self, observer: &O)

let observer know when the data associated with this sg-data is dropped.

Trait Implementations

impl<O> PartialEq<SgData<O>> for SgData<O> where
    O: Clone, 

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

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

#[must_use]

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

This method tests for !=.

impl<O> Default for SgData<O> where
    O: Clone, 

fn default() -> Self

Returns the "default value" for a type.

impl<O> Clone for SgData<O> where
    O: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O> Extend<u8> for SgData<O> where
    O: Clone, 

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = u8>, 

Extends a collection with the contents of an iterator.

impl<'a, O> Extend<&'a [u8]> for SgData<O> where
    O: Clone, 

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = &'a [u8]>, 

Extends a collection with the contents of an iterator.

impl<O> Extend<Iovec> for SgData<O> where
    O: Clone, 

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = Iovec>, 

Extends a collection with the contents of an iterator.

impl<'a, O> Extend<&'a Iovec> for SgData<O> where
    O: Clone, 

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = &'a Iovec>, 

Extends a collection with the contents of an iterator.

impl<O> Extend<SgData<O>> for SgData<O> where
    O: Clone, 

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = Self>, 

Extends a collection with the contents of an iterator.

impl<O> From<SgList> for SgData<O> where
    O: Clone, 

fn from(sglist: SgList) -> Self

Performs the conversion.

impl<O> From<Vec<u8>> for SgData<O> where
    O: Clone, 

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

Performs the conversion.

impl<O> From<Vec<Vec<u8>>> for SgData<O> where
    O: Clone, 

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

Performs the conversion.

impl<O> From<Iovec> for SgData<O> where
    O: Clone, 

fn from(elt: Iovec) -> Self

Performs the conversion.

impl<O> From<Vec<Iovec>> for SgData<O> where
    O: Clone, 

fn from(vec: Vec<Iovec>) -> Self

Performs the conversion.

impl<O> From<Zle> for SgData<O> where
    O: Clone, 

fn from(zle: Zle) -> Self

Performs the conversion.

impl<O> From<SgData<O>> for Vec<u8> where
    O: Clone, 

fn from(sgdata: SgData<O>) -> Self

Performs the conversion.

impl<O> Add<SgData<O>> for SgData<O> where
    O: Clone, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<O> AddAssign<SgData<O>> for SgData<O> where
    O: Clone, 

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<O> FromIterator<u8> for SgData<O> where
    O: Clone, 

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = u8>, 

Creates a value from an iterator.

impl<O> FromIterator<Vec<u8>> for SgData<O> where
    O: Clone, 

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Vec<u8>>, 

Creates a value from an iterator.

impl<O> FromIterator<Iovec> for SgData<O> where
    O: Clone, 

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Iovec>, 

Creates a value from an iterator.

impl<O> FromIterator<SgData<O>> for SgData<O> where
    O: Clone, 

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Self>, 

Creates a value from an iterator.

impl<O: Debug> Debug for SgData<O> where
    O: Clone, 

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

Formats the value using the given formatter.

impl<O> Serialize for SgData<O> where
    O: Clone, 

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de, O> Deserialize<'de> for SgData<O> where
    O: Clone, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<O> Value for SgData<O> where
    O: Clone, 

fn serialize(
    &self,
    _record: &Record,
    key: Key,
    serializer: &mut dyn Serializer
) -> Result

Serialize self into Serializer