Struct LayoutImageBlock 

#[non_exhaustive]
pub struct LayoutImageBlock {
    pub mime_type: String,
    pub image_text: String,
    pub annotations: Option<Annotations>,
    pub image_source: Option<ImageSource>,
    /* private fields */
}

Represents an image type block.

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.

mime_type: String

Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml).

image_text: String

Text extracted from the image using OCR or alt text describing the image.

annotations: Option<Annotations>

Annotation of the image block.

image_source: Option<ImageSource>

Source of the image.

Implementations

impl LayoutImageBlock

pub fn new() -> Self

Creates a new default instance.

pub fn set_mime_type<T: Into<String>>(self, v: T) -> Self

Sets the value of mime_type.

Example

let x = LayoutImageBlock::new().set_mime_type("example");

pub fn set_image_text<T: Into<String>>(self, v: T) -> Self

Sets the value of image_text.

Example

let x = LayoutImageBlock::new().set_image_text("example");

pub fn set_annotations<T>(self, v: T) -> Self

where T: Into<Annotations>,

Sets the value of annotations.

Example

use google_cloud_documentai_v1::model::document::Annotations;
let x = LayoutImageBlock::new().set_annotations(Annotations::default()/* use setters */);

pub fn set_or_clear_annotations<T>(self, v: Option<T>) -> Self

where T: Into<Annotations>,

Sets or clears the value of annotations.

Example

use google_cloud_documentai_v1::model::document::Annotations;
let x = LayoutImageBlock::new().set_or_clear_annotations(Some(Annotations::default()/* use setters */));
let x = LayoutImageBlock::new().set_or_clear_annotations(None::<Annotations>);

pub fn set_image_source<T: Into<Option<ImageSource>>>(self, v: T) -> Self

Sets the value of image_source.

Note that all the setters affecting image_source are mutually exclusive.

Example

use google_cloud_documentai_v1::model::document::document_layout::document_layout_block::layout_image_block::ImageSource;
let x = LayoutImageBlock::new().set_image_source(Some(ImageSource::BlobAssetId("example".to_string())));

pub fn blob_asset_id(&self) -> Option<&String>

The value of image_source if it holds a BlobAssetId, None if the field is not set or holds a different branch.

pub fn set_blob_asset_id<T: Into<String>>(self, v: T) -> Self

Sets the value of image_source to hold a BlobAssetId.

Note that all the setters affecting image_source are mutually exclusive.

Example

let x = LayoutImageBlock::new().set_blob_asset_id("example");
assert!(x.blob_asset_id().is_some());
assert!(x.gcs_uri().is_none());
assert!(x.data_uri().is_none());

pub fn gcs_uri(&self) -> Option<&String>

The value of image_source if it holds a GcsUri, None if the field is not set or holds a different branch.

pub fn set_gcs_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of image_source to hold a GcsUri.

Note that all the setters affecting image_source are mutually exclusive.

Example

let x = LayoutImageBlock::new().set_gcs_uri("example");
assert!(x.gcs_uri().is_some());
assert!(x.blob_asset_id().is_none());
assert!(x.data_uri().is_none());

pub fn data_uri(&self) -> Option<&String>

The value of image_source if it holds a DataUri, None if the field is not set or holds a different branch.

pub fn set_data_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of image_source to hold a DataUri.

Note that all the setters affecting image_source are mutually exclusive.

Example

let x = LayoutImageBlock::new().set_data_uri("example");
assert!(x.data_uri().is_some());
assert!(x.blob_asset_id().is_none());
assert!(x.gcs_uri().is_none());

Trait Implementations

impl Clone for LayoutImageBlock

fn clone(&self) -> LayoutImageBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutImageBlock

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

Formats the value using the given formatter.

impl Default for LayoutImageBlock

fn default() -> LayoutImageBlock

Returns the “default value” for a type.

impl Message for LayoutImageBlock

fn typename() -> &'static str

The typename of this message.

impl PartialEq for LayoutImageBlock

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LayoutImageBlock