Struct PyBytesWriter 

pub struct PyBytesWriter<'py> {
    python: Python<'py>,
    writer: NonNull<PyBytesWriter>,
}

Fields

python: Python<'py>

writer: NonNull<PyBytesWriter>

Available on non-Py_LIMITED_API only.

Implementations

impl<'py> PyBytesWriter<'py>

pub fn new(py: Python<'py>) -> PyResult<Self>

Create a new PyBytesWriter with a default initial capacity.

pub fn with_capacity(py: Python<'py>, capacity: usize) -> PyResult<Self>

Create a new PyBytesWriter with the specified initial capacity.

pub fn len(&self) -> usize

Get the current length of the internal buffer.

fn as_mut_ptr(&mut self) -> *mut u8

Available on non-Py_LIMITED_API only.

unsafe fn set_len(&mut self, new_len: usize) -> PyResult<()>

Available on non-Py_LIMITED_API only.

Set the length of the internal buffer to new_len. The new bytes are uninitialized.

Safety

The caller must ensure the new bytes are initialized. This will also make all pointers returned by as_mut_ptr invalid, so the caller must not hold any references to the buffer across this call.

Trait Implementations

impl<'py> Drop for PyBytesWriter<'py>

Available on non-Py_LIMITED_API only.

fn drop(&mut self)

Executes the destructor for this type.

impl<'py> IntoPyObject<'py> for PyBytesWriter<'py>

const OUTPUT_TYPE: PyStaticExpr = PyBytes::TYPE_HINT

Available on crate feature experimental-inspect only.

Extracts the type hint information for this type when it appears as a return value.

type Target = PyBytes

The Python output type

type Output = Bound<'py, PyBytes>

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.

#[doc(hidden)]

fn owned_sequence_into_pyobject<I>( iter: I, py: Python<'py>, _: Token, ) -> Result<Bound<'py, PyAny>, PyErr>

where I: IntoIterator<Item = Self> + AsRef<[Self]>, I::IntoIter: ExactSizeIterator<Item = Self>,

Converts sequence of Self into a Python object. Used to specialize Vec<u8>, [u8; N] and SmallVec<[u8; N]> as a sequence of bytes into a bytes object.

#[doc(hidden)]

const SEQUENCE_OUTPUT_TYPE: PyStaticExpr = _

Available on crate feature experimental-inspect only.

The output type of IntoPyObject::owned_sequence_into_pyobject and IntoPyObject::borrowed_sequence_into_pyobject

impl<'py> TryFrom<PyBytesWriter<'py>> for Bound<'py, PyBytes>

type Error = PyErr

The type returned in the event of a conversion error.

fn try_from(value: PyBytesWriter<'py>) -> Result<Self, Self::Error>

Performs the conversion.

impl Write for PyBytesWriter<'_>

Available on non-Py_LIMITED_API only.

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

Writes a buffer into this writer, returning how many bytes were written.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers.

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

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

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

Attempts to write an entire buffer into this writer.

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_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.