Struct RawCircle

pub struct RawCircle { /* private fields */ }

A thread-safe version of CharCircle.

The API of this buffer is almost identical to CharCircle except that it uses external mutability, and it does not provide a means to consume its characters from an external iterator.

Implementations

impl RawCircle

pub fn new(s: String) -> RawCircle

Construct a new RawCircle using a string as the initial buffer.

pub fn empty() -> RawCircle

Construct a new, empty RawCircle.

pub fn len(&self) -> usize

The number of UTF-8 bytes in the buffer.

pub fn n_chars(&self) -> usize

The number of characters in the buffer.

pub fn capacity(&self) -> usize

The number of bytes the buffer can hold before reallocating.

This refers to the length of the backing vector. That vector may have additional capacity allocated to it that is not reported by this method.

pub fn read_char(&mut self) -> Option<char>

Read the next character in the buffer.

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

Read bytes from this circle into a buffer.

This method will only ever read complete UTF-8 characters. It returns the number of bytes read; it never returns an error.

This is the implementation of std::io::Read for RawCircle.

pub fn read_str<'a>(&mut self, buf: &'a mut [u8]) -> &'a str

Read bytes from this circle into a buffer.

This method is equivalent to RawCircle::read except the return value is the buffer cast to a &str.

pub fn write_char(&mut self, ch: char)

Write a character into the buffer.

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

Read bytes from a string into this buffer;

This method will only ever write complete UTF-8 characters. It returns the number of bytes written. This method returns an error if the input is not valid UTF-8.

This is the implementation of std::io::Write for RawCircle.

pub fn write_str(&mut self, buf: &str) -> usize

Read bytes from a string into this buffer;

This method is equivalent to RawCircle::write except that it cannot return an error because the input is valid UTF-8.

pub fn into_vec(self) -> Vec<u8>

Unpack this circular buffer into a byte vector.

pub fn into_string(self) -> String

Unpack this circular buffer into a string.

Trait Implementations

impl Clone for RawCircle

fn clone(&self) -> RawCircle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawCircle

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

Formats the value using the given formatter.

impl Default for RawCircle

fn default() -> RawCircle

Returns the “default value” for a type.

impl From<RawCircle> for String

fn from(c: RawCircle) -> String

Converts to this type from the input type.

impl From<RawCircle> for Vec<u8>

fn from(c: RawCircle) -> Vec<u8>

Converts to this type from the input type.

impl From<String> for RawCircle

fn from(s: String) -> RawCircle

Converts to this type from the input type.

impl Read for RawCircle

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 RawCircle

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.