Struct Writer

pub struct Writer<W: Write> { /* private fields */ }

A fixed width data writer. It writes data provided in iterators to any type that implements io::Write.

Example

Writing a Vec<String> to a file:

use fixed_width;
use std::io::Write;
use fixed_width::Writer;

let data = vec![
    "1234".to_string(),
    "5678".to_string(),
];

let mut wrtr = Writer::from_memory();
wrtr.write_iter(data.iter());
wrtr.flush();

Implementations

impl<W> Writer<W>

where W: Write,

pub fn from_writer(wrtr: W) -> Self

Creates a new writer from any type that implements io::Write

pub fn from_buffer(buf: BufWriter<W>) -> Self

Creates a new writer from a io::BufWriter that wraps a type that implements io::Write

pub fn write_serialized<T: FixedWidth + Serialize>( &mut self, records: impl Iterator<Item = T>, ) -> Result<()>

Writes the given iterator of FixedWidth + Serialize types to the underlying writer, optionally inserting linebreaks if specified.

pub fn write_iter<T: AsByteSlice>( &mut self, records: impl Iterator<Item = T>, ) -> Result<()>

Writes the given iterator of types that implement AsByteSlice to the underlying writer, optionally inserting linebreaks if specified.

pub fn write_linebreak(&mut self) -> Result<()>

Writes the linebreak specified to the underlying writer. Does nothing if there is no linebreak.

pub fn linebreak(self, linebreak: LineBreak) -> Self

Sets the linebreak desired for this data. Defaults to LineBreak::None.

impl Writer<Vec<u8>>

pub fn from_memory() -> Self

Creates a new writer in memory from a Vec<u8>.

Trait Implementations

impl From<Writer<Vec<u8>>> for String

fn from(writer: Writer<Vec<u8>>) -> Self

Converts the writer into a String, but panics if unable to flush to the underlying

impl From<Writer<Vec<u8>>> for Vec<u8>

fn from(writer: Writer<Vec<u8>>) -> Self

Converts the writer into a Vec<u8>, but panics if unable to flush to the underlying writer.

impl<W> Write for Writer<W>

where W: Write,

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

Writes a buffer into the underlying writer.

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

flushes the underlying writer.

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.