Struct bytecodec::io::ReadBuf
[−]
[src]
pub struct ReadBuf<B> { /* fields omitted */ }
Read buffer.
Methods
impl<B: AsRef<[u8]> + AsMut<[u8]>> ReadBuf<B>
[src]
pub fn new(inner: B) -> Self
[src]
Makes a new ReadBuf
instance.
pub fn len(&self) -> usize
[src]
Returns the number of filled bytes in the buffer.
pub fn room(&self) -> usize
[src]
Returns the free space of the buffer.
Invariant: self.len() + self.room() <= self.capacity()
pub fn capacity(&self) -> usize
[src]
Returns the capacity of the buffer.
pub fn is_empty(&self) -> bool
[src]
Returns true
if the buffer is empty, otherwise false
.
pub fn is_full(&self) -> bool
[src]
Returns true
if the buffer is full, otherwise false
.
pub fn stream_state(&self) -> StreamState
[src]
Returns the state of the stream that operated in the last fill()
call.
pub fn stream_state_mut(&mut self) -> &mut StreamState
[src]
Returns a mutable reference to the StreamState
instance.
pub fn fill<R: Read>(&mut self, reader: R) -> Result<()>
[src]
Fills the read buffer by reading bytes from the given reader.
The fill process continues until one of the following condition is satisfied:
- The read buffer became full
- A read operation returned a
WouldBlock
error - The input stream has reached EOS
ⓘImportant traits for &'a mut Wpub fn inner_ref(&self) -> &B
[src]
Returns a reference to the inner bytes of the buffer.
ⓘImportant traits for &'a mut Wpub fn inner_mut(&mut self) -> &mut B
[src]
Returns a mutable reference to the inner bytes of the buffer.
pub fn into_inner(self) -> B
[src]
Takes ownership of ReadBuf
and returns the inner bytes of the buffer.
Trait Implementations
impl<B: Debug> Debug for ReadBuf<B>
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<B: AsRef<[u8]> + AsMut<[u8]>> Read for ReadBuf<B>
[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, 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
ⓘImportant traits for &'a mut Wfn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
ⓘImportant traits for Bytes<R>fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
ⓘImportant traits for Chars<R>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
ⓘImportant traits for Chain<T, U>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
ⓘImportant traits for Take<T>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