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

pub struct PageRef {
    pub page: i64,
    pub layout_type: i32,
    pub layout_id: String,
}

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

layout_type: i32

Optional. The type of the layout element that is being referenced. If not specified the whole page is assumed to be referenced.

layout_id: String

Optional. The [Page.Layout.id][google.cloud.documentai.v1beta2.Document.Page.Layout.id] on the page that this element references. If [LayoutRef.type][] is specified this id must also be specified.

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() -> PageRef

Returns the "default value" for a type.

impl Message for PageRef

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

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

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

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

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

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

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

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

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

impl PartialEq<PageRef> 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: &PageRef) -> bool

This method tests for !=.

impl StructuralPartialEq for PageRef