Struct Chunk 

#[non_exhaustive]
pub struct Chunk {
    pub chunk_id: String,
    pub source_block_ids: Vec<String>,
    pub content: String,
    pub page_span: Option<ChunkPageSpan>,
    pub page_headers: Vec<ChunkPageHeader>,
    pub page_footers: Vec<ChunkPageFooter>,
    /* private fields */
}

Represents a chunk.

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.

chunk_id: String

ID of the chunk.

source_block_ids: Vec<String>

Unused.

content: String

Text content of the chunk.

page_span: Option<ChunkPageSpan>

Page span of the chunk.

page_headers: Vec<ChunkPageHeader>

Page headers associated with the chunk.

page_footers: Vec<ChunkPageFooter>

Page footers associated with the chunk.

Implementations

impl Chunk

pub fn new() -> Self

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

Sets the value of chunk_id.

Example

let x = Chunk::new().set_chunk_id("example");

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

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of source_block_ids.

Example

let x = Chunk::new().set_source_block_ids(["a", "b", "c"]);

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

Sets the value of content.

Example

let x = Chunk::new().set_content("example");

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

where T: Into<ChunkPageSpan>,

Sets the value of page_span.

Example

use google_cloud_documentai_v1::model::document::chunked_document::chunk::ChunkPageSpan;
let x = Chunk::new().set_page_span(ChunkPageSpan::default()/* use setters */);

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

where T: Into<ChunkPageSpan>,

Sets or clears the value of page_span.

Example

use google_cloud_documentai_v1::model::document::chunked_document::chunk::ChunkPageSpan;
let x = Chunk::new().set_or_clear_page_span(Some(ChunkPageSpan::default()/* use setters */));
let x = Chunk::new().set_or_clear_page_span(None::<ChunkPageSpan>);

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

where T: IntoIterator<Item = V>, V: Into<ChunkPageHeader>,

Sets the value of page_headers.

Example

use google_cloud_documentai_v1::model::document::chunked_document::chunk::ChunkPageHeader;
let x = Chunk::new()
    .set_page_headers([
        ChunkPageHeader::default()/* use setters */,
        ChunkPageHeader::default()/* use (different) setters */,
    ]);

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

where T: IntoIterator<Item = V>, V: Into<ChunkPageFooter>,

Sets the value of page_footers.

Example

use google_cloud_documentai_v1::model::document::chunked_document::chunk::ChunkPageFooter;
let x = Chunk::new()
    .set_page_footers([
        ChunkPageFooter::default()/* use setters */,
        ChunkPageFooter::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for Chunk

fn clone(&self) -> Chunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Chunk

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

Formats the value using the given formatter.

impl Default for Chunk

fn default() -> Chunk

Returns the “default value” for a type.

impl Message for Chunk

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Chunk

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Chunk