[−][src]Struct rpos_drv::RingByteBuffer
A ring byte buffer used to operate byte streams
Example
let mut buffer = rpos_drv::RingByteBuffer::with_capacity(100); buffer.write(&[0, 1, 2, 3]).unwrap(); assert_eq!(buffer.len(), 4 as usize);
Methods
impl RingByteBuffer
[src]
ⓘImportant traits for RingByteBufferpub fn with_capacity(capacity: usize) -> RingByteBuffer
[src]
create a ring buffer with capacity
pub fn len(&self) -> usize
[src]
the data in the ring buffer
pub fn capacity(&self) -> usize
[src]
the capacity of the ring buffer
pub fn free_space(&self) -> usize
[src]
free space in bytes in the ring buffer
pub fn current_read_slice(&self) -> &[u8]
[src]
current read slice
Example
let read_slice = buffer.current_read_slice(); let read = some_stream.write(read_slice).unwrap(); buffer.skip_bytes(read);
pub fn skip_bytes(&mut self, bytes: usize) -> usize
[src]
skip bytes
pub fn read_from(&mut self, upstream: &mut impl Read) -> Result<usize>
[src]
read data from upstream to fill the ring buffer
Example
let read = buffer.read_from(&mut some_stream).unwrap(); println!("{} bytes read from stream to fill buffer, current length of buffer is: {}", read, buffer.len());
Trait Implementations
impl PartialEq<RingByteBuffer> for RingByteBuffer
[src]
fn eq(&self, other: &RingByteBuffer) -> bool
[src]
fn ne(&self, other: &RingByteBuffer) -> bool
[src]
impl Clone for RingByteBuffer
[src]
ⓘImportant traits for RingByteBufferfn clone(&self) -> RingByteBuffer
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for RingByteBuffer
[src]
impl Write for RingByteBuffer
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn flush(&mut self) -> Result<()>
[src]
fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>
1.36.0[src]
Like write
, except that it writes from a slice of buffers. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
Attempts to write an entire buffer into this writer. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Write
. Read more
impl Read for RingByteBuffer
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>
1.36.0[src]
Like read
, except that it reads into a slice of buffers. Read more
unsafe fn initializer(&self) -> Initializer
[src]
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
Creates an adaptor which will read at most limit
bytes from it. Read more
Auto Trait Implementations
impl Send for RingByteBuffer
impl Sync for RingByteBuffer
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> 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, U> TryInto<U> 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> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,