[][src]Struct sequoia_openpgp::serialize::stream::LiteralWriter

pub struct LiteralWriter<'a> { /* fields omitted */ }

Writes a literal data packet.

Literal data, i.e. the payload or plaintext, must be wrapped in a literal data packet to be transported over OpenPGP (see Section 5.9 of RFC 4880). The body will be written using partial length encoding, or, if the body is short, using full length encoding.

Note on metadata

A literal data packet can communicate some metadata: a hint as to what kind of data is transported, the original file name, and a timestamp. Note that this metadata will not be authenticated by signatures (but will be authenticated by a SEIP/MDC container), and are therefore unreliable and should not be trusted.

Therefore, it is good practice not to set this metadata when creating a literal data packet, and not to interpret it when consuming one.

Methods

impl<'a> LiteralWriter<'a>[src]

pub fn new(inner: Message<'a>) -> Self[src]

Creates a new literal writer.

Example

use std::io::Write;
use sequoia_openpgp as openpgp;
use openpgp::serialize::stream::{Message, LiteralWriter};

let mut sink = vec![];
{
    let message = Message::new(&mut sink);
    let mut message = LiteralWriter::new(message)
        // Customize the `LiteralWriter` here.
        .build()?;
    message.write_all(b"Hello world.")?;
    message.finalize()?;
}
assert_eq!(b"\xcb\x12b\x00\x00\x00\x00\x00Hello world.",
           sink.as_slice());

pub fn format(self, format: DataFormat) -> Self[src]

Sets the data format.

Example

use std::io::Write;
use sequoia_openpgp as openpgp;
use openpgp::types::DataFormat;
use openpgp::serialize::stream::{Message, LiteralWriter};

let mut sink = vec![];
{
    let message = Message::new(&mut sink);
    let mut message = LiteralWriter::new(message)
        .format(DataFormat::Text)
        .build()?;
    message.write_all(b"Hello world.")?;
    message.finalize()?;
}
assert_eq!(b"\xcb\x12t\x00\x00\x00\x00\x00Hello world.",
           sink.as_slice());

pub fn filename<B: AsRef<[u8]>>(self, filename: B) -> Result<Self>[src]

Sets the filename.

The standard does not specify the encoding. Filenames must not be longer than 255 bytes. Returns an error if the given name is longer than that.

Example

use std::io::Write;
use sequoia_openpgp as openpgp;
use openpgp::serialize::stream::{Message, LiteralWriter};

let mut sink = vec![];
{
    let message = Message::new(&mut sink);
    let mut message = LiteralWriter::new(message)
        .filename("foobar")?
        .build()?;
    message.write_all(b"Hello world.")?;
    message.finalize()?;
}
assert_eq!(b"\xcb\x18b\x06foobar\x00\x00\x00\x00Hello world.",
           sink.as_slice());

pub fn date<T: Into<SystemTime>>(self, timestamp: T) -> Result<Self>[src]

Sets the date.

This date may be the modification date or the creation date. Returns an error if the given date is not representable by OpenPGP.

Example

use std::io::Write;
use sequoia_openpgp as openpgp;
use openpgp::types::Timestamp;
use openpgp::serialize::stream::{Message, LiteralWriter};

let mut sink = vec![];
{
    let message = Message::new(&mut sink);
    let mut message = LiteralWriter::new(message)
        .date(Timestamp::from(1585925313))?
        .build()?;
    message.write_all(b"Hello world.")?;
    message.finalize()?;
}
assert_eq!(b"\xcb\x12b\x00\x5e\x87\x4c\xc1Hello world.",
           sink.as_slice());

pub fn build(self) -> Result<Message<'a>>[src]

Builds the literal writer, returning the writer stack.

The next step is to write the payload to the writer stack.

Example

use std::io::Write;
use sequoia_openpgp as openpgp;
use openpgp::serialize::stream::{Message, LiteralWriter};

let mut sink = vec![];
{
    let message = Message::new(&mut sink);
    let mut message = LiteralWriter::new(message)
        // Customize the `LiteralWriter` here.
        .build()?;
    message.write_all(b"Hello world.")?;
    message.finalize()?;
}
assert_eq!(b"\xcb\x12b\x00\x00\x00\x00\x00Hello world.",
           sink.as_slice());

Trait Implementations

impl<'a> Debug for LiteralWriter<'a>[src]

impl<'a> Write for LiteralWriter<'a>[src]

fn write_vectored(&mut self, bufs: &[IoVec]) -> Result<usize, Error>[src]

🔬 This is a nightly-only experimental API. (iovec)

Like write, except that it writes from a slice of buffers. Read more

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0
[src]

Attempts to write an entire buffer into this writer. Read more

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0
[src]

Writes a formatted string into this writer, returning any error encountered. Read more

fn by_ref(&mut self) -> &mut Self
1.0.0
[src]

Creates a "by reference" adaptor for this instance of Write. Read more

Auto Trait Implementations

impl<'a> !Send for LiteralWriter<'a>

impl<'a> !Sync for LiteralWriter<'a>

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.