gpg::SnapshotMetadataChange::CoverImage

#include <snapshot_metadata_change_cover_image.h>

A single data structure which allows you to access data about the status of a specific cover image.

Summary

Constructors and Destructors

CoverImage(std::shared_ptr< const SnapshotMetadataChangeCoverImageImpl > impl)
Constructs a CoverImage from a shared_ptr to a CoverImageImpl.
CoverImage(const CoverImage & copy_from)
Creates a copy of an existing CoverImage.
CoverImage(CoverImage && move_from)
Moves an existing CoverImage.
~CoverImage()

Public functions

Data() const
const std::vector< uint8_t > &
The image data to set as the cover image.
Height() const
int
The height of the image in pixels.
MimeType() const
const std::string &
The mime-type of the image file to set as the cover image.
Width() const
int
The width of the image in pixels.
operator=(const CoverImage & copy_from)
Assigns this CoverImage by moving another one into it.
operator=(CoverImage && move_from)
Assignment operator for assigning this CoverImage's value from another CoverImage.

Public functions

CoverImage

 CoverImage(
  std::shared_ptr< const SnapshotMetadataChangeCoverImageImpl > impl
)

Constructs a CoverImage from a shared_ptr to a CoverImageImpl.

Intended for internal use by the API.

CoverImage

 CoverImage(
  const CoverImage & copy_from
)

Creates a copy of an existing CoverImage.

CoverImage

 CoverImage(
  CoverImage && move_from
)

Moves an existing CoverImage.

Data

const std::vector< uint8_t > & Data() const 

The image data to set as the cover image.

The format of this vector of bytes is defined by the MimeType() of the cover image.

Height

int Height() const 

The height of the image in pixels.

MimeType

const std::string & MimeType() const 

The mime-type of the image file to set as the cover image.

Example "image/png".

Width

int Width() const 

The width of the image in pixels.

operator=

CoverImage & operator=(
  const CoverImage & copy_from
)

Assigns this CoverImage by moving another one into it.

operator=

CoverImage & operator=(
  CoverImage && move_from
)

Assignment operator for assigning this CoverImage's value from another CoverImage.

r-value-reference version.

~CoverImage

 ~CoverImage()