Struct StreamBuf

pub struct StreamBuf { /* private fields */ }

Automatically resizing buffer.

Implementations

impl StreamBuf

pub fn new() -> StreamBuf

Returns a new StreamBuf.

Equivalent to with_max_len(usize::max_len())

Examples

use asyncio::StreamBuf;

let mut sbuf = StreamBuf::new();

pub fn with_max_len(max: usize) -> StreamBuf

Returns a new StreamBuf with the max length of the allocatable size.

Examples

use asyncio::StreamBuf;

let mut sbuf = StreamBuf::with_max_len(1024);

pub fn capacity(&self) -> usize

Returns an allocated size of the buffer.

Examples

use asyncio::StreamBuf;

let mut sbuf = StreamBuf::new();
assert_eq!(sbuf.capacity(), 0);

pub fn clear(&mut self)

Clears the buffer, removing all values.

Examples

use asyncio::StreamBuf;

let mut sbuf = StreamBuf::from(vec![1,2,3]);
sbuf.clear();
assert_eq!(sbuf.is_empty(), true);

pub fn consume(&mut self, len: usize)

Remove characters from the input sequence.

Examples

use asyncio::StreamBuf;

let mut sbuf = StreamBuf::from(vec![1,2,3]);
assert_eq!(sbuf.len(), 3);
sbuf.consume(3);
assert_eq!(sbuf.len(), 0);

pub fn commit(&mut self, len: usize)

Move characters from the output sequence to the input sequence.

Examples

use asyncio::StreamBuf;

let mut sbuf = StreamBuf::new();
let _ = sbuf.prepare(256);
assert_eq!(sbuf.len(), 0);
sbuf.commit(3);
assert_eq!(sbuf.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the empty buffer.

Examples

use asyncio::StreamBuf;

let sbuf = StreamBuf::new();
assert!(sbuf.is_empty());

pub fn len(&self) -> usize

Returns a length of the input sequence.

Examples

use asyncio::StreamBuf;

let sbuf = StreamBuf::from(vec![1,2,3]);
assert_eq!(sbuf.len(), 3);

pub fn max_len(&self) -> usize

Returns a maximum length of the StreamBuf.

Examples

use asyncio::StreamBuf;

let sbuf = StreamBuf::new();
assert_eq!(sbuf.max_len(), usize::max_value());

pub fn prepare(&mut self, len: usize) -> Result<&mut [u8]>

Returns a &mut [u8] that represents a output sequence.

Examples

use asyncio::StreamBuf;

let mut sbuf = StreamBuf::with_max_len(8);
assert_eq!(sbuf.prepare(5).unwrap().len(), 5);
sbuf.commit(5);
assert_eq!(sbuf.prepare(5).unwrap().len(), 3);

pub fn prepare_exact(&mut self, len: usize) -> Result<&mut [u8]>

Returns a &mut [u8] that represents a output sequence.

Examples

use asyncio::StreamBuf;

let mut sbuf = StreamBuf::with_max_len(8);
assert_eq!(sbuf.prepare_exact(5).unwrap().len(), 5);
sbuf.commit(5);
assert!(sbuf.prepare_exact(5).is_err());

pub fn as_slice(&self) -> &[u8]

Returns a &[u8] that represents the input sequence.

pub fn as_mut_slice(&mut self) -> &mut [u8]

Returns a &mut [u8] that represents the input sequence.

Trait Implementations

impl AsMut<[u8]> for StreamBuf

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<StreamBuf> for StreamBuf

fn as_mut(&mut self) -> &mut StreamBuf

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for StreamBuf

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<StreamBuf> for StreamBuf

fn as_ref(&self) -> &StreamBuf

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for StreamBuf

fn clone(&self) -> StreamBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamBuf

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

Formats the value using the given formatter.

impl Default for StreamBuf

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a [u8]> for StreamBuf

fn from(buf: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for StreamBuf

fn from(buf: &'a str) -> Self

Converts to this type from the input type.

impl From<CString> for StreamBuf

fn from(buf: CString) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for StreamBuf

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

Converts to this type from the input type.

impl Read for StreamBuf

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Write for StreamBuf

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.