Struct Writer 

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

Writes an iCalendar or vCard file.

Folds all content lines to lines that are no longer than 75 bytes (not including line breaks). A CRLF line break is appended to each content line.

Writer will always output valid UTF-8 to the underlying Write.

Performance

It can be excessively inefficient to work directly with something that implements Write. For example, every call to write on std::net::TcpStream results in a system call. Wrapping writer in a io::BufWriter may improve performance significantly.

Example

The following example illustrates how to write a simple vCard file:

use ical_vcard::{Contentline, Identifier, Param, ParamValue, Value, Writer};

let contentlines = [
    Contentline::try_new("BEGIN", "VCARD")?,
    Contentline::try_new("FN", "Mr. John Example")?,
    Contentline::try_new("BDAY", "20230326")?
        .try_add_param("VALUE", ["date-and-or-time"])?,
    Contentline::try_new("END", "VCARD")?,
];

// For the sake of simplicity and testability, the vCard is written to a Vec. However, in a
// real application, one would probably write it to disk or do some further processing (e.g.
// compression)
let vcard = {
    let mut buffer = Vec::new();
    let mut writer = Writer::new(&mut buffer);
    writer.write_all(contentlines)?;
    buffer
};

let expected = "\
BEGIN:VCARD\r
FN:Mr. John Example\r
BDAY;VALUE=date-and-or-time:20230326\r
END:VCARD\r
".as_bytes();

assert_eq!(vcard, expected);

Implementations

impl<W: Write> Writer<W>

pub fn new(writer: W) -> Self

Creates a new Writer.

Note that you can also pass &mut W instead of W for any W that implements Write.

pub fn write(&mut self, contentline: &Contentline) -> Result<()>

Writes a single content line.

Flushes the underlying Write afterwards.

Errors

Fails in case of an io::Error.

pub fn write_all<C, I>(&mut self, contentlines: I) -> Result<()>

where C: Borrow<Contentline>, I: IntoIterator<Item = C>,

Writes a sequence of contentlines.

Flushes the underlying Write afterwards.

Errors

Fails in case of an io::Error.

pub fn inner(&self) -> &W

Returns a reference to the inner Write.

pub fn inner_mut(&mut self) -> &mut W

Returns a mutable reference to the inner Write.

pub fn into_inner(self) -> W

Returns the inner Write

Trait Implementations

impl<W: Debug + Write> Debug for Writer<W>

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

Formats the value using the given formatter.