Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.56 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.56 KB
Raw

quoted-printable

Build Status Crate

A quoted-printable decoder and encoder.

API

quoted-printable exposes three functions at the moment:

    decode<R: AsRef<[u8]>>(input: R, mode: ParseMode) -> Result<Vec<u8>, QuotedPrintableError>
    encode<R: AsRef<[u8]>>(input: R) -> Vec<u8>
    encode_to_str<R: AsRef<[u8]>>(input: R) -> String

using R: AsRef<[u8]> means that you can pass in a variety of types, including: String, &String, &str, Vec<u8>, &Vec<u8>, &[u8], Box<[u8]>, Arc<[u8]>

The decode function can be used to convert a quoted-printable string into the decoded bytes, as per the description in IETF RFC 2045, section 6.7. The ParseMode option can be used to control whether the decoding is "strict" or "robust", as per the comments in that RFC. In general you should probably use "robust" decoding, as it will gracefully handle more malformed input.

The encode and encode_to_str functions obviously do the reverse, and convert a set of raw bytes into quoted-printable.

no_std

This crate supports no_std. By default the crate targets std via the std feature. You can deactivate the default-features to support no_std like this:

quoted-printable = { version = "*", default-features = false }

Documentation

See document on https://docs.rs.