Struct CStringWriter

pub struct CStringWriter(/* private fields */);

A helper that enables writing into CStrings

This type implements Write and yields a CString at the end, which is useful for generating string data to be shared with the Falco plugin framework.

The Write implementation returns an error whenever the data to be written contains a NUL byte.

Example:

use std::ffi::CString;
use falco_plugin::strings::CStringWriter;
use std::io::Write;
let mut writer = CStringWriter::default();

write!(writer, "Hello, world, five={}", 5)?;

let output: CString = writer.into_cstring();

Implementations

impl CStringWriter

pub fn into_cstring(self) -> CString

Finalize the writer object and return a CString

This method consumes the CStringWriter and returns a CString containing all the written data

pub fn store(self, target: &mut CString)

Finalize the writer object and store the output in a CString

This method consumes the CStringWriter, but instead of returning a CString, it stores the output in an existing CString (replacing any previous content).

Trait Implementations

impl Debug for CStringWriter

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

Formats the value using the given formatter.

impl Default for CStringWriter

fn default() -> CStringWriter

Returns the “default value” for a type.

impl Write for CStringWriter

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

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

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

Flushes 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, 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.