Struct PyUnicodeWriter 

pub(crate) struct PyUnicodeWriter<'py> {
    python: Python<'py>,
    writer: NonNull<PyUnicodeWriter>,
    last_error: Option<PyErr>,
}

Available on Py_3_14 and non-Py_LIMITED_API only.

The PyUnicodeWriter is a utility for efficiently constructing Python strings

Fields

python: Python<'py>

writer: NonNull<PyUnicodeWriter>

last_error: Option<PyErr>

Implementations

impl<'py> PyUnicodeWriter<'py>

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

Creates a new PyUnicodeWriter.

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

Creates a new PyUnicodeWriter with the specified initial capacity.

pub fn into_py_string(self) -> PyResult<Bound<'py, PyString>>

Consumes the PyUnicodeWriter and returns a Bound<PyString> containing the constructed string.

pub fn take_error(&mut self) -> Option<PyErr>

When fmt::Write returned an error, this function can be used to retrieve the last error that occurred.

fn as_ptr(&self) -> *mut PyUnicodeWriter

fn set_error(&mut self)

Trait Implementations

impl Drop for PyUnicodeWriter<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl<'py> IntoPyObject<'py> for PyUnicodeWriter<'py>

type Target = PyString

The Python output type

type Output = Bound<'py, <PyUnicodeWriter<'py> as IntoPyObject<'py>>::Target>

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>) -> PyResult<Bound<'py, PyString>>

Performs the conversion.

const OUTPUT_TYPE: PyStaticExpr = _

Available on crate feature experimental-inspect only.

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

#[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> TryInto<Bound<'py, PyString>> for PyUnicodeWriter<'py>

type Error = PyErr

The type returned in the event of a conversion error.

fn try_into(self) -> PyResult<Bound<'py, PyString>>

Performs the conversion.

impl Write for PyUnicodeWriter<'_>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.