Struct didcomm_rs::AttachmentBuilder

pub struct AttachmentBuilder { /* private fields */ }

Builder of attachment metadata and payload. Used to construct and inject Attachment into Message

Implementations

impl AttachmentBuilder

pub fn new(include_mod_time: bool) -> Self

Constructor of new instance of the builder.

Parameters

• included_mod_time - bool value indicating if this attachment should be timestamped on attaching. If true - will update lastmod_time property on builder consumption.

pub fn with_id(self, id: &str) -> Self

Optional, but recommended identifier of attachment content.

Parameters

• id - String of Attachment identifier

pub fn with_description(self, description: &str) -> Self

Human redable description string

Parameters

• description - String of description for this Attachment

pub fn with_filename(self, filename: &str) -> Self

Attachment file name specifier.

Parameters

• filename - name of the file attached

pub fn with_media_type(self, media_type: &str) -> Self

Describes the media (MIME) type of the attached content

Parameters

• media_type - String of media type description

pub fn with_format(self, format: &str) -> Self

Describes the format of the attachment if the media_type is not sufficient.

Parameters

• format - String format identifier

pub fn external_size(self, bytes: usize) -> Self

mostly relevant when content is included by reference instead of by value. Lets the receiver guess how expensive it will be, in time, bandwidth, and storage, to fully fetch the attachment.

Parameters

• bytes - usize of bytes.

pub fn with_data(self, attachment_data: AttachmentDataBuilder) -> Self

Attach actual payload in form of AttachmentData Consumes AttachmentDataBuilder to do so.

Parameters

• attachment_data - ‘AttachmentDataBuilder’ instance, prepopulated.