Struct aws_sdk_kinesisvideoarchivedmedia::types::Image

#[non_exhaustive]
pub struct Image {
    pub time_stamp: Option<DateTime>,
    pub error: Option<ImageError>,
    pub image_content: Option<String>,
}

A structure that contains the Timestamp, Error, and ImageContent.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

time_stamp: Option<DateTime>

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

error: Option<ImageError>

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

image_content: Option<String>

An attribute of the Image object that is Base64 encoded.

Implementations

impl Image

pub fn time_stamp(&self) -> Option<&DateTime>

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

pub fn error(&self) -> Option<&ImageError>

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

• There is no media that exists for the specified Timestamp.

• The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

pub fn image_content(&self) -> Option<&str>

An attribute of the Image object that is Base64 encoded.

impl Image

pub fn builder() -> ImageBuilder

Creates a new builder-style object to manufacture Image.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl PartialEq<Image> for Image

fn eq(&self, other: &Image) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Image