Struct Relationship

#[non_exhaustive]
pub struct Relationship {
    pub type: Option<RelationshipType>,
    pub ids: Option<Vec<String>>,
}

Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships. For more information, see Block.

The Type element provides the type of the relationship for all blocks in the IDs array.

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.

type: Option<RelationshipType>

The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.

• VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.

• CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.

• MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.

• ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.

• TABLE - A list of IDs that identify associated TABLE block types.

• TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

• TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

ids: Option<Vec<String>>

An array of IDs for related blocks. You can get the type of the relationship from the Type element.

Implementations

impl Relationship

pub fn type(&self) -> Option<&RelationshipType>

The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.

• VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.

• CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.

• MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.

• ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.

• TABLE - A list of IDs that identify associated TABLE block types.

• TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

• TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

pub fn ids(&self) -> &[String]

An array of IDs for related blocks. You can get the type of the relationship from the Type element.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ids.is_none().

impl Relationship

pub fn builder() -> RelationshipBuilder

Creates a new builder-style object to manufacture Relationship.

Trait Implementations

impl Clone for Relationship

fn clone(&self) -> Relationship

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Relationship

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

Formats the value using the given formatter.

impl PartialEq for Relationship

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