Struct basic_text::TextReader

pub struct TextReader<Inner: ReadStrLayered> { /* private fields */ }

A Read implementation which translates from an input Read implementation producing an arbitrary byte sequence into a valid Basic Text stream.

Examples

use basic_text::TextReader;

let input = TextReader::new(std::io::stdin());

// read from `input`

Implementations

impl<Inner: Read> TextReader<Utf8Reader<LayeredReader<Inner>>>

pub fn new(inner: Inner) -> Self

Construct a new instance of TextReader wrapping inner, which can be anything that implements Read.

pub fn with_nel_compatibility(inner: Inner) -> Result<Self>

Like new, but replaces U+85 (NEL) with U+A instead of U+20.

pub fn with_lsps_compatibility(inner: Inner) -> Result<Self>

Like new, but replaces U+2028 (LS) and U+2029 (PS) with U+A instead of U+20.

impl<Inner: ReadStrLayered> TextReader<Inner>

pub fn from_utf8(inner: Inner) -> Self

Construct a new instance of TextReader wrapping inner, which can be anything that implements ReadStrLayered, such as a Utf8Reader.

pub fn from_utf8_with_nel_compatibility(inner: Inner) -> Result<Self>

Like from_utf8, but replaces U+85 (NEL) with U+A instead of U+20.

pub fn from_utf8_with_lsps_compatibility(inner: Inner) -> Result<Self>

Like from_utf8, but replaces U+2028 (LS) and U+2029 (PS) with U+A instead of U+20.

Trait Implementations

impl<Inner: ReadStrLayered + AsHandleOrSocket> AsHandleOrSocket for TextReader<Inner>

fn as_handle_or_socket(&self) -> BorrowedHandleOrSocket<'_>

Like AsHandle::as_handle and AsSocket::as_socket but can return either type.

impl<Inner: ReadStrLayered + AsRawHandleOrSocket> AsRawHandleOrSocket for TextReader<Inner>

fn as_raw_handle_or_socket(&self) -> RawHandleOrSocket

Like AsRawHandle::as_raw_handle and AsRawSocket::as_raw_socket but can return either type.

impl<Inner: ReadStrLayered> Bufferable for TextReader<Inner>

fn abandon(&mut self)

Close the resource and abandon any pending buffered contents or errors.

fn suggested_buffer_size(&self) -> usize

A suggested size, in bytes, for buffering for performance.

impl<Inner: ReadStrLayered + Debug> Debug for TextReader<Inner>

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

Formats the value using the given formatter.

impl<Inner: ReadStrLayered> Read for TextReader<Inner>

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>

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

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

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

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_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

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

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere
    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<Inner: ReadStrLayered> ReadLayered for TextReader<Inner>

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

Like Read::read, but also returns a Status.

fn minimum_buffer_size(&self) -> usize

Some streams require a buffer of at least a certain size.

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

Like Read::read_vectored, but also returns a Status.

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

Like Read::read_exact, but uses read_with_status to avoid performing an extra read at the end.

impl<Inner: ReadStrLayered> ReadStr for TextReader<Inner>

fn read_str(&mut self, buf: &mut str) -> Result<usize>

Like read but produces the result in a str. Be sure to check the size field of the return value to see how many bytes were written.

fn read_exact_str(&mut self, buf: &mut str) -> Result<()>

Like read_exact but produces the result in a str.

impl<Inner: ReadStrLayered> ReadStrLayered for TextReader<Inner>

fn read_str_with_status(&mut self, buf: &mut str) -> Result<(usize, Status)>

Like read_with_status but produces the result in a str. Be sure to check the return value to see how many bytes were written.

fn read_exact_str_using_status(&mut self, buf: &mut str) -> Result<Status>

Like read_exact but produces the result in a str.

impl<Inner: ReadStrLayered> ReadText for TextReader<Inner>

fn read_text_substr(&mut self, buf: &mut TextSubstr) -> Result<usize>

Like read_str but for reading Basic Text content. Note that the resulting data may not be a Basic Text string, as it may be eg. a portion of a stream that starts with a non-starter.

fn read_exact_text_substr(&mut self, buf: &mut TextSubstr) -> Result<()>

Like read_exact_str but for reading Basic Text content. As with read_text, the resulting string may not be a Basic Text string.

fn read_to_text_string(&mut self, buf: &mut TextString) -> Result<usize>

Like read_to_string, but reads into a TextString.

impl<Inner: ReadStrLayered> ReadTextLayered for TextReader<Inner>

fn read_text_substr_with_status(
    &mut self,
    buf: &mut TextSubstr
) -> Result<(usize, Status)>

Like read_str_with_status but for reading Basic Text data. Note that the resulting data may not be a Basic Text string, as it may be eg. a portion of a stream that starts with a non-starter.

fn read_exact_text_substr_using_status(
    &mut self,
    buf: &mut TextSubstr
) -> Result<Status>

Like read_exact_str_using_status but for reading Basic Text content. As with read_text, the resulting string may not be a Basic Text string.