Struct PyTextFile

pub struct PyTextFile { /* private fields */ }

Rust wrapper for a Python text file-like object that implements the io protocol.

This wrapper is similar to PyBinaryFile, but it assumes that the file is text and returns the byte representation of the text.

The Python file-like object must have a read method that returns either a bytes object or a str object.

Seek operations are not supported on text files, since the equivalent Python file-like objects seek by characters, not bytes.

Implementations

impl PyTextFile

pub fn new(file: PyObject) -> PyResult<Self>

Create a new PyTextFile from a Python file-like object and an encoding.

Trait Implementations

impl Clone for PyTextFile

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyTextFile

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

Formats the value using the given formatter.

impl From<Bound<'_, PyAny>> for PyTextFile

fn from(obj: Bound<'_, PyAny>) -> Self

Converts to this type from the input type.

impl From<Py<PyAny>> for PyTextFile

fn from(obj: PyObject) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for PyTextFile

type Target = PyAny

The Python output type

type Output = Bound<'py, PyAny>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error>

Performs the conversion.

impl Read for PyTextFile

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.