[−][src]Struct data_buffer::DataBuffer
Buffer of plain old data. The data is stored as an array of bytes (Vec<u8>
).
DataBuffer
keeps track of the type stored within via an explicit TypeId
member. This allows
one to hide the type from the compiler and check it only when necessary. It is particularly
useful when the type of data is determined at runtime (e.g. when parsing numeric data).
Methods
impl DataBuffer
[src]
pub fn with_type<T: Any>() -> Self
[src]
Construct an empty DataBuffer
with a specific type.
pub fn with_buffer_type(other: &DataBuffer) -> Self
[src]
Construct a DataBuffer
with the same type as the given buffer without copying its data.
pub fn with_capacity<T: Any>(n: usize) -> Self
[src]
Construct an empty DataBuffer
with a capacity for a given number of typed elements. For
setting byte capacity use with_byte_capacity
.
pub fn with_size<T: Any + Clone>(n: usize, def: T) -> Self
[src]
Construct a typed DataBuffer
with a given size and filled with the specified default
value.
Examples
let buf = DataBuffer::with_size(8, 42usize); // Create buffer let buf_vec: Vec<usize> = buf.into_vec().unwrap(); // Convert into `Vec` assert_eq!(buf_vec, vec![42usize; 8]);
pub fn from_vec<T: Any>(vec: Vec<T>) -> Self
[src]
Construct a DataBuffer
from a given Vec<T>
reusing the space already allocated by the
given vector.
Examples
let vec = vec![1u8, 3, 4, 1, 2]; let buf = DataBuffer::from_vec(vec.clone()); // Convert into buffer let nu_vec: Vec<u8> = buf.into_vec().unwrap(); // Convert back into `Vec` assert_eq!(vec, nu_vec);
pub fn from_slice<T: Any + Clone>(slice: &[T]) -> Self
[src]
Construct a DataBuffer
from a given slice by cloning the data.
pub fn copy_from_slice<T: Any + Copy>(&mut self, slice: &[T]) -> &mut Self
[src]
Copy data from a given slice into the current buffer.
pub fn clear(&mut self)
[src]
Clear the data buffer without destroying its type information.
pub fn fill<T: Any + Clone>(&mut self, def: T) -> Option<&mut Self>
[src]
Fill the current buffer with copies of the given value. The size of the buffer is left
unchanged. If the given type doesn't patch the internal type, None
is returned, otherwise
a mut reference to the modified buffer is returned.
Examples
let vec = vec![1u8, 3, 4, 1, 2]; let mut buf = DataBuffer::from_vec(vec.clone()); // Convert into buffer buf.fill(0u8); assert_eq!(buf.into_vec::<u8>().unwrap(), vec![0u8, 0, 0, 0, 0]);
pub fn push<T: Any + Debug>(&mut self, element: T) -> Option<&mut Self>
[src]
Add an element to this buffer. If the type of the given element coincides with the type
stored by this buffer, then the modified buffer is returned via a mutable reference.
Otherwise, None
is returned.
pub fn check<T: Any>(self) -> Option<Self>
[src]
Check if the current buffer contains elements of the specified type. Returns Some(self)
if the type matches and None
otherwise.
pub fn check_ref<T: Any>(&self) -> Option<&Self>
[src]
Check if the current buffer contains elements of the specified type. Returns None
if the
check fails, otherwise a reference to self is returned.
pub fn check_mut<'a, T: Any>(&'a mut self) -> Option<&'a mut Self>
[src]
Check if the current buffer contains elements of the specified type. Same as check_ref
but consumes and produces a mut reference to self.
pub fn element_type_id(&self) -> TypeId
[src]
Get the TypeId
of data stored within this buffer.
pub fn len(&self) -> usize
[src]
Get the number of elements stored in this buffer.
pub fn is_empty(&self) -> bool
[src]
Check if there are any elements stored in this buffer.
pub fn byte_capacity(&self) -> usize
[src]
Get the byte capacity of this buffer.
pub fn element_size(&self) -> usize
[src]
Get the size of the element type.
pub fn iter<'a, T: Any + 'a>(&'a self) -> Option<Iter<T>>
[src]
Return an iterator to a slice representing typed data.
Returs None
if the given type T
doesn't match the internal.
Examples
let vec = vec![1.0_f32, 23.0, 0.01, 42.0, 11.43]; let buf = DataBuffer::from(vec.clone()); // Convert into buffer for (i, &val) in buf.iter::<f32>().unwrap().enumerate() { assert_eq!(val, vec[i]); }
pub fn iter_mut<'a, T: Any + 'a>(&'a mut self) -> Option<IterMut<T>>
[src]
Return an iterator to a mutable slice representing typed data.
Returs None
if the given type T
doesn't match the internal.
pub fn append_clone_to_vec<'a, T>(
&self,
vec: &'a mut Vec<T>
) -> Option<&'a mut Vec<T>> where
T: Any + Clone,
[src]
&self,
vec: &'a mut Vec<T>
) -> Option<&'a mut Vec<T>> where
T: Any + Clone,
Append cloned items from this buffer to a given Vec<T>
. Return the mutable reference
Some(vec)
if type matched the internal type and None
otherwise.
pub fn append_copy_to_vec<'a, T>(
&self,
vec: &'a mut Vec<T>
) -> Option<&'a mut Vec<T>> where
T: Any + Copy,
[src]
&self,
vec: &'a mut Vec<T>
) -> Option<&'a mut Vec<T>> where
T: Any + Copy,
Append copied items from this buffer to a given Vec<T>
. Return the mutable reference
Some(vec)
if type matched the internal type and None
otherwise. This may be faster than
append_clone_to_vec
.
pub fn clone_into_vec<T: Any + Clone>(&self) -> Option<Vec<T>>
[src]
Clones contents of self
into the given Vec
.
pub fn copy_into_vec<T: Any + Copy>(&self) -> Option<Vec<T>>
[src]
Copies contents of self
into the given Vec
.
pub fn into_vec<T: Any>(self) -> Option<Vec<T>>
[src]
An alternative to using the Into
trait. This function helps the compiler
determine the type T
automatically.
pub fn as_slice<T: Any>(&self) -> Option<&[T]>
[src]
Convert this buffer into a typed slice.
Returs None
if the given type T
doesn't match the internal.
pub fn as_mut_slice<T: Any>(&mut self) -> Option<&mut [T]>
[src]
Convert this buffer into a typed mutable slice.
Returs None
if the given type T
doesn't match the internal.
pub fn get<T: Any + Copy>(&self, i: usize) -> Option<T>
[src]
Get i
'th element of the buffer by value.
pub fn get_ref<T: Any>(&self, i: usize) -> Option<&T>
[src]
Get a const
reference to the i
'th element of the buffer.
pub fn get_mut<T: Any>(&mut self, i: usize) -> Option<&mut T>
[src]
Get a mutable reference to the i
'th element of the buffer.
pub unsafe fn get_unchecked<T: Any + Copy>(&self, i: usize) -> T
[src]
Get i
'th element of the buffer by value without checking type.
This can be used to reinterpret the internal data as a different type. Note that if the
size of the given type T
doesn't match the size of the internal type, i
will really
index the i
th T
sized chunk in the current buffer. See the implementation for details.
pub unsafe fn get_unchecked_ref<T: Any>(&self, i: usize) -> &T
[src]
Get a const
reference to the i
'th element of the buffer.
This can be used to reinterpret the internal data as a different type. Note that if the
size of the given type T
doesn't match the size of the internal type, i
will really
index the i
th T
sized chunk in the current buffer. See the implementation for details.
pub unsafe fn get_unchecked_mut<T: Any>(&mut self, i: usize) -> &mut T
[src]
Get a mutable reference to the i
'th element of the buffer.
This can be used to reinterpret the internal data as a different type. Note that if the
size of the given type T
doesn't match the size of the internal type, i
will really
index the i
th T
sized chunk in the current buffer. See the implementation for details.
pub fn get_bytes(&self, i: usize) -> &[u8]
[src]
Get a const
reference to the byte slice of the i
'th element of the buffer.
pub fn get_bytes_mut(&mut self, i: usize) -> &mut [u8]
[src]
Get a mutable reference to the byte slice of the i
'th element of the buffer.
pub fn reinterpret_into_vec<T>(self) -> Vec<T>
[src]
Move buffer data to a vector with a given type, reinterpreting the data type as required.
pub fn reinterpret_as_slice<T>(&self) -> &[T]
[src]
Borrow buffer data and reinterpret it as a slice of a given type.
pub fn reinterpret_as_mut_slice<T>(&mut self) -> &mut [T]
[src]
Mutably borrow buffer data and reinterpret it as a mutable slice of a given type.
pub fn reinterpret_iter<T>(&self) -> Iter<T>
[src]
Borrow buffer data and iterate over reinterpreted underlying data.
pub fn reinterpret_iter_mut<T>(&mut self) -> IterMut<T>
[src]
Mutably borrow buffer data and mutably iterate over reinterpreted underlying data.
pub fn bytes_ref(&self) -> &[u8]
[src]
Peak at the internal representation of the data.
pub fn bytes_mut(&mut self) -> &mut [u8]
[src]
Get a mutable reference to the internal data representation.
pub fn byte_chunks<'a>(&'a self) -> impl Iterator<Item = &'a [u8]> + 'a
[src]
Iterate over chunks type sized chunks of bytes without interpreting them. This avoids needing to know what type data you're dealing with. This type of iterator is useful for transferring data from one place to another for a generic buffer.
pub fn byte_chunks_mut<'a>(
&'a mut self
) -> impl Iterator<Item = &'a mut [u8]> + 'a
[src]
&'a mut self
) -> impl Iterator<Item = &'a mut [u8]> + 'a
Mutably iterate over chunks type sized chunks of bytes without interpreting them. This avoids needing to know what type data you're dealing with. This type of iterator is useful for transferring data from one place to another for a generic buffer, or modifying the underlying untyped bytes (e.g. bit twiddling).
pub fn push_bytes(&mut self, bytes: &[u8]) -> Option<&mut Self>
[src]
Add bytes to this buffer. If the size of the given slice coincides with the number of bytes
occupied by the underlying element type, then these bytes are added to the underlying data
buffer and a mutable reference to the buffer is returned.
Otherwise, None
is returned, and the buffer remains unmodified.
pub fn extend_bytes(&mut self, bytes: &[u8]) -> Option<&mut Self>
[src]
Add bytes to this buffer. If the size of the given slice is a multiple of the number of bytes
occupied by the underlying element type, then these bytes are added to the underlying data
buffer and a mutable reference to the buffer is returned.
Otherwise, None
is returned and the buffer is unmodified.
pub fn append_bytes(&mut self, bytes: &mut Vec<u8>) -> Option<&mut Self>
[src]
Move bytes to this buffer. If the size of the given vector is a multiple of the number of bytes
occupied by the underlying element type, then these bytes are moved to the underlying data
buffer and a mutable reference to the buffer is returned.
Otherwise, None
is returned and both the buffer and the input vector remain unmodified.
Trait Implementations
impl<T> Into<Option<Vec<T>>> for DataBuffer where
T: Any + Clone,
[src]
T: Any + Clone,
Convert a DataBuffer
to a Option<Vec<T>>
.
impl PartialEq<DataBuffer> for DataBuffer
[src]
fn eq(&self, other: &DataBuffer) -> bool
[src]
fn ne(&self, other: &DataBuffer) -> bool
[src]
impl<T> From<Vec<T>> for DataBuffer where
T: Any,
[src]
T: Any,
Convert a Vec<T>
to a DataBuffer
.
fn from(vec: Vec<T>) -> DataBuffer
[src]
impl<'a, T> From<&'a [T]> for DataBuffer where
T: Any + Clone,
[src]
T: Any + Clone,
Convert a &[T]
to a DataBuffer
.
fn from(slice: &'a [T]) -> DataBuffer
[src]
impl Clone for DataBuffer
[src]
fn clone(&self) -> DataBuffer
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for DataBuffer
[src]
impl Hash for DataBuffer
[src]
Auto Trait Implementations
impl Send for DataBuffer
impl Sync for DataBuffer
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
impl<T> From for T
[src]
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,