Struct BlockInfo 

pub struct BlockInfo {

    pub sheet_idx: usize,
    pub sheet_id: u16,
    pub block_id: usize,
    pub row_start: usize,
    pub row_cnt: usize,
    pub col_start: usize,
    pub col_cnt: usize,
    pub schema: Option<BlockSchema>,
    pub field_renders: Vec<FieldRenderEntry>,
    pub cells: Vec<BlockCellInfo>,
    pub description: String,
    pub owner: String,
    pub modify_policy: ModifyPolicy,
    pub permissions: BlockPermissions,
    pub analyzes: Option<usize>,
    pub analyzed_by: Vec<usize>,
    pub pivot: Option<PivotSpecParts>,
}

Fields

sheet_idx: usize

sheet_id: u16

block_id: usize

row_start: usize

0-based sheet row of the block’s top-left cell.

row_cnt: usize

col_start: usize

0-based sheet column of the block’s top-left cell.

col_cnt: usize

schema: Option<BlockSchema>

field_renders: Vec<FieldRenderEntry>

cells: Vec<BlockCellInfo>

description: String

What the block is for, in prose — empty when nobody said. The schema describes the shape of the records; this is the only thing that says what they mean, which is what an AI reading the sheet needs.

owner: String

The craft that created the block, empty for one the user made.

modify_policy: ModifyPolicy

The block’s default write policy.

permissions: BlockPermissions

Per-operation overrides of it. Do not read these apart to decide whether an edit is allowed — ask Workbook::may_modify_block, so every host answers the question the same way.

analyzes: Option<usize>

Which block this one ANALYSES, when it is an analysis block — a total row, a set of statistics, later a pivot. None for an ordinary block.

Reported in both directions on purpose. An agent reading the sheet has to be able to tell a table from its analysis: the rows of an analysis block are its own records, not the source’s, and summing them alongside the source would double-count. See design/block-analysis.md.

analyzed_by: Vec<usize>

The blocks that analyse THIS one. Empty for a block nobody summarises.

pivot: Option<PivotSpecParts>

When this analysis block is a PIVOT, the recipe it derives from. None for a total row and for an ordinary block.

Reported because a pivot’s SHAPE is data, so a reader has to know it is looking at one: a stale pivot’s numbers are each correct while a whole group is simply absent, which is the one way a block can mislead without being wrong. See design/block-pivot.md §8.

Trait Implementations

impl Clone for BlockInfo

fn clone(&self) -> BlockInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockInfo

fn deserialize<D>( deserializer: D, ) -> Result<BlockInfo, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<_GentsDummyBlockInfo> for BlockInfo

fn from(value: _GentsDummyBlockInfo) -> BlockInfo

Converts to this type from the input type.

impl Serialize for BlockInfo

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for BlockInfo

fn _register(manager: &mut DescriptorManager, generic_base: bool) -> usize

fn _ts_name() -> String

fn _is_optional() -> bool

fn _tag() -> Option<&'static str>