Struct cramjam::io::RustyBuffer

pub struct RustyBuffer { /* fields omitted */ }

A native Rust file-like object. Reading and writing takes place through the Rust implementation, allowing access to the underlying bytes in Python.

Python Example

>>> from cramjam import Buffer
>>> buf = Buffer(b"bytes")
>>> buf.read()
b'bytes'

Implementations

impl RustyBuffer

A Buffer object, similar to cramjam.File only the bytes are held in-memory

Example

from cramjam import Buffer
buf = Buffer(b'start bytes')
buf.read(5)
b'start'

pub fn __init__(data: Option<BytesType<'_>>) -> PyResult<Self>

Instantiate the object, optionally with any supported bytes-like object in BytesType

pub fn len(&self) -> usize

Length of the underlying buffer

pub fn write(&mut self, input: BytesType<'_>) -> PyResult<usize>

Write some bytes to the buffer, where input data can be anything in BytesType

pub fn read<'a>(
    &mut self,
    py: Python<'a>,
    n_bytes: Option<usize>
) -> PyResult<&'a PyBytes>

Read from the buffer in its current position, returns bytes; optionally specify number of bytes to read.

pub fn readinto(&mut self, output: BytesType<'_>) -> PyResult<usize>

Read from the buffer in its current position, into a BytesType object.

pub fn seek(
    &mut self,
    position: isize,
    whence: Option<usize>
) -> PyResult<usize>

Seek to a position within the buffer. whence follows the same values as IOBase.seek where:

0: from start of the stream
1: from current stream position
2: from end of the stream

pub fn seekable(&self) -> bool

Whether the buffer is seekable; here just for compatibility, it always returns True.

pub fn tell(&self) -> usize

Give the current position of the buffer.

pub fn set_len(&mut self, size: usize) -> PyResult<()>

Set the length of the buffer. If less than current length, it will truncate to the size given; otherwise will be null byte filled to the size.

pub fn truncate(&mut self) -> PyResult<()>

Truncate the buffer

Trait Implementations

impl Default for RustyBuffer

fn default() -> RustyBuffer

Returns the “default value” for a type.

impl<'a> ExtractExt<'a> for &'a RustyBuffer

type Target = PyRef<'a, RustyBuffer>

impl<'a> ExtractExt<'a> for &'a mut RustyBuffer

type Target = PyRefMut<'a, RustyBuffer>

impl From<Vec<u8, Global>> for RustyBuffer

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

Performs the conversion.

impl HasMethodsInventory for RustyBuffer

type Methods = Pyo3MethodsInventoryForRustyBuffer

impl IntoPy<Py<PyAny>> for RustyBuffer

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<'p> PyBufferGetBufferProtocol<'p> for RustyBuffer

type Result = PyResult<()>

impl<'p> PyBufferProtocol<'p> for RustyBuffer

fn bf_getbuffer(
    slf: PyRefMut<'_, Self>,
    view: *mut Py_buffer,
    flags: c_int
) -> <RustyBuffer as PyBufferGetBufferProtocol<'p>>::Result

fn bf_releasebuffer(
    _slf: PyRefMut<'_, Self>,
    _view: *mut Py_buffer
) -> <RustyBuffer as PyBufferReleaseBufferProtocol<'p>>::Result

impl<'p> PyBufferReleaseBufferProtocol<'p> for RustyBuffer

type Result = ()

impl PyClass for RustyBuffer

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

impl PyClassAlloc for RustyBuffer

unsafe fn new(py: Python<'_>, subtype: *mut PyTypeObject) -> *mut Self::Layout

Allocate the actual field for #[pyclass].

unsafe fn dealloc(py: Python<'_>, self_: *mut Self::Layout)

Deallocate #[pyclass] on the Python heap.

impl PyClassSend for RustyBuffer

type ThreadChecker = ThreadCheckerStub<RustyBuffer>

impl<'p> PyObjectBoolProtocol<'p> for RustyBuffer

type Result = bool

impl<'p> PyObjectProtocol<'p> for RustyBuffer

fn __repr__(&'p self) -> <RustyBuffer as PyObjectReprProtocol<'p>>::Result

fn __bool__(&'p self) -> <RustyBuffer as PyObjectBoolProtocol<'p>>::Result

fn __getattr__(&'p self, name: Self::Name) -> Self::Result where
    Self: PyObjectGetAttrProtocol<'p>, 

fn __setattr__(
    &'p mut self,
    name: Self::Name,
    value: Self::Value
) -> Self::Result where
    Self: PyObjectSetAttrProtocol<'p>, 

fn __delattr__(&'p mut self, name: Self::Name) -> Self::Result where
    Self: PyObjectDelAttrProtocol<'p>, 

fn __str__(&'p self) -> Self::Result where
    Self: PyObjectStrProtocol<'p>, 

fn __format__(&'p self, format_spec: Self::Format) -> Self::Result where
    Self: PyObjectFormatProtocol<'p>, 

fn __hash__(&'p self) -> Self::Result where
    Self: PyObjectHashProtocol<'p>, 

fn __bytes__(&'p self) -> Self::Result where
    Self: PyObjectBytesProtocol<'p>, 

fn __richcmp__(&'p self, other: Self::Other, op: CompareOp) -> Self::Result where
    Self: PyObjectRichcmpProtocol<'p>, 

impl<'p> PyObjectReprProtocol<'p> for RustyBuffer

type Result = String

impl PyProtoMethods for RustyBuffer

fn for_each_proto_slot<Visitor: FnMut(PyType_Slot)>(visitor: Visitor)

fn get_buffer() -> Option<&'static PyBufferProcs>

impl<'p> PySequenceContainsProtocol<'p> for RustyBuffer

type Item = u8

type Result = bool

impl<'p> PySequenceLenProtocol<'p> for RustyBuffer

type Result = usize

impl<'p> PySequenceProtocol<'p> for RustyBuffer

fn __len__(&'p self) -> <RustyBuffer as PySequenceLenProtocol<'p>>::Result

fn __contains__(
    &'p self,
    x: <RustyBuffer as PySequenceContainsProtocol<'p>>::Item
) -> <RustyBuffer as PySequenceContainsProtocol<'p>>::Result

fn __getitem__(&'p self, idx: Self::Index) -> Self::Result where
    Self: PySequenceGetItemProtocol<'p>, 

fn __setitem__(
    &'p mut self,
    idx: Self::Index,
    value: Self::Value
) -> Self::Result where
    Self: PySequenceSetItemProtocol<'p>, 

fn __delitem__(&'p mut self, idx: Self::Index) -> Self::Result where
    Self: PySequenceDelItemProtocol<'p>, 

fn __concat__(&'p self, other: Self::Other) -> Self::Result where
    Self: PySequenceConcatProtocol<'p>, 

fn __repeat__(&'p self, count: Self::Index) -> Self::Result where
    Self: PySequenceRepeatProtocol<'p>, 

fn __inplace_concat__(&'p mut self, other: Self::Other) -> Self::Result where
    Self: PySequenceInplaceConcatProtocol<'p>, 

fn __inplace_repeat__(&'p mut self, count: Self::Index) -> Self::Result where
    Self: PySequenceInplaceRepeatProtocol<'p>, 

impl PyTypeInfo for RustyBuffer

type Type = RustyBuffer

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

type Layout = PyCell<Self>

Layout

type BaseLayout = PyCellBase<PyAny>

Layout of Basetype.

type Initializer = PyClassInitializer<Self>

Initializer for layout

type AsRefTarget = PyCell<Self>

Utility type to make Py::as_ref work

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

PyTypeObject instance for this type.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl Read for RustyBuffer

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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> 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, appending them to 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 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 Seek for RustyBuffer

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

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

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

impl Write for RustyBuffer

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

Write a buffer into this writer, 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_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, 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.