Struct sequoia_openpgp::serialize::stream::LiteralWriter

source ·
pub struct LiteralWriter<'a> { /* private fields */ }
Expand description

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.

Implementations§

source§

impl<'a> LiteralWriter<'a>

source

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

Creates a new literal writer.

§Examples
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());
source

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

Sets the data format.

§Examples
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());
source

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

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.

§Examples
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());
source

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

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.

§Examples
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());
source

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

Builds the literal writer, returning the writer stack.

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

§Examples
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§

source§

impl<'a> Debug for LiteralWriter<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> Write for LiteralWriter<'a>

source§

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

Write a buffer into this writer, returning how many bytes were written. Read more
source§

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

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. Read more
1.0.0 · source§

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

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

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. Read more
1.0.0 · source§

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for LiteralWriter<'a>

§

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

§

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

§

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

§

impl<'a> Unpin for LiteralWriter<'a>

§

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

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.