Ditto  1.0.14
Public Member Functions | List of all members
ditto::Attachment Class Reference

Represents an attachment and can be used to insert the associated attachment into a document at a specific key. More...

Public Member Functions

std::vector< uint8_t > get_data ()
 Returns the attachment's data as a byte array. More...
 
bool copy_to_path (const std::string &dest_path)
 Copies the attachment to the specified file path. More...
 
std::map< std::string, std::string > get_metadata () const
 Gets the attachment's metadata. More...
 
std::string get_type () const
 
nlohmann::json::binary_t get_id () const
 
uint64_t get_len () const
 

Detailed Description

Represents an attachment and can be used to insert the associated attachment into a document at a specific key.

Member Function Documentation

◆ copy_to_path()

bool ditto::Attachment::copy_to_path ( const std::string &  dest_path)

Copies the attachment to the specified file path.

Parameters
Thepath that the attachment should be copied to.

◆ get_data()

std::vector< uint8_t > ditto::Attachment::get_data ( )

Returns the attachment's data as a byte array.

Returns
The attachment's data as bytes.

◆ get_metadata()

std::map< std::string, std::string > ditto::Attachment::get_metadata ( ) const

Gets the attachment's metadata.

Returns
The attachment's metadata.