Struct google_api_proto::google::cloud::documentai::v1beta2::document::page_anchor::PageRef

pub struct PageRef {
    pub page: i64,
    pub layout_type: i32,
    pub layout_id: String,
    pub bounding_poly: Option<BoundingPoly>,
    pub confidence: f32,
}

Represents a weak reference to a page element within a document.

Fields

page: i64

Required. Index into the [Document.pages][google.cloud.documentai.v1beta2.Document.pages] element, for example using [Document.pages][page_refs.page] to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.

layout_type: i32

Optional. The type of the layout element that is being referenced if any.

layout_id: String

👎Deprecated

Optional. Deprecated. Use [PageRef.bounding_poly][google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.bounding_poly] instead.

bounding_poly: Option<BoundingPoly>

Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it’s referring to.

confidence: f32

Optional. Confidence of detected page element, if applicable. Range \[0, 1\].

Implementations

impl PageRef

pub fn layout_type(&self) -> LayoutType

Returns the enum value of layout_type, or the default if the field is set to an invalid enum value.

pub fn set_layout_type(&mut self, value: LayoutType)

Sets layout_type to the provided enum value.

Trait Implementations

impl Clone for PageRef

fn clone(&self) -> PageRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageRef

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

Formats the value using the given formatter.

impl Default for PageRef

fn default() -> Self

Returns the “default value” for a type.

impl Message for PageRef

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PageRef

fn eq(&self, other: &PageRef) -> 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 PageRef