Struct jack::RingBufferReader
[−]
[src]
pub struct RingBufferReader { /* fields omitted */ }
Read end of the ring buffer. Can only be used from one thread (can be different from the write thread).
Methods
impl RingBufferReader
[src]
fn get_vector<'a>(&'a self) -> (&'a [u8], &'a [u8])
[src]
Fill a data structure with a description of the current readable data held in the ringbuffer. This description is returned in a two slices. Two slices are needed because the data to be read may be split across the end of the ringbuffer. The first slice represents the bytes ready to be read. If the second slice is not empty, it is the continuation of the data that ended in the first slices. For convenience, consider using peek_iter instead.
fn read_buffer(&mut self, buf: &mut [u8]) -> usize
[src]
Read data from the ringbuffer. Returns: the number of bytes read, which may range from 0 to buf.len().
fn peek(&self, buf: &mut [u8]) -> usize
[src]
Read data from the ringbuffer. Opposed to read_buffer() this function does not move the read pointer. Thus it's a convenient way to inspect data in the ringbuffer in a continous fashion. The price is that the data is copied into a user provided buffer. For "raw" non-copy inspection of the data in the ringbuffer use get_vector() or peek_iter. Returns: the number of bytes read, which may range from 0 to buf.len()
fn advance(&mut self, cnt: usize)
[src]
Advance the read pointer. use this after peek/peek_iter or get_vector to advance the buffer pointer.
fn space(&self) -> usize
[src]
Return the number of bytes available for reading.
fn peek_iter<'a>(&'a self) -> Chain<Iter<'a, u8>, Iter<'a, u8>>
[src]
Iterator that goes over all the data available to read.
Trait Implementations
impl Send for RingBufferReader
[src]
impl Read for RingBufferReader
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. 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, placing them into 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 chars(self) -> Chars<Self>
[src]
🔬 This is a nightly-only experimental API. (io
)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an [Iterator
] over [char
]s. 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