Struct asyncio::StreamBuf

pub struct StreamBuf { /* fields omitted */ }

Automatically resizing buffer.

Methods

impl StreamBuf

fn new() -> StreamBuf

Returns a new StreamBuf.

Equivalent to with_max_len(usize::max_len())

Examples

use asyncio::StreamBuf;

let mut sbuf = StreamBuf::new();

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);

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);

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);

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);

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);

fn is_empty(&self) -> bool

Returns true if the empty buffer.

Examples

use asyncio::StreamBuf;

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

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);

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());

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);

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());

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

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

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

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

Trait Implementations

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, __arg_0: &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 AsRef<StreamBuf> for StreamBuf

fn as_ref(&self) -> &StreamBuf

Performs the conversion.

impl AsMut<StreamBuf> for StreamBuf

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

Performs the conversion.

impl AsRef<[u8]> for StreamBuf

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

Performs the conversion.

impl AsMut<[u8]> for StreamBuf

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

Performs the conversion.

impl From<Vec<u8>> for StreamBuf

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

Performs the conversion.

impl From<CString> for StreamBuf

fn from(buf: CString) -> Self

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

Unstable (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 chars.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Write for StreamBuf

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

Write a buffer into this object, returning how many bytes were written.

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

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

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

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

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

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

Creates a "by reference" adaptor for this instance of Write.