Struct CreateBlock 

pub struct CreateBlock {
    pub sheet_idx: usize,
    pub id: usize,
    pub master_row: usize,
    pub master_col: usize,
    pub row_cnt: usize,
    pub col_cnt: usize,
    pub owner: Option<String>,
    pub modify_policy: Option<ModifyPolicy>,
    pub permissions: Option<BlockPermissions>,
    pub description: Option<String>,
    pub analyzes: Option<usize>,
    pub pivot: Option<PivotSpecParts>,
}

Create a new block.

Note that the block id is assigned by you and must be unused on the sheet (see Workbook::get_available_block_id); an id already in use rejects the transaction. master_row/master_col is the top-left corner and must be an ordinary cell, not inside another block.

owner, modify_policy, permissions and description are metadata the host uses to gate write access at runtime — ask Workbook::may_modify_block rather than reading them apart. The engine does not enforce them itself: a payload carries no trace of who prompted it, so only the host knows whether an edit came from a person or a craft.

Fields

sheet_idx: usize

id: usize

master_row: usize

master_col: usize

row_cnt: usize

col_cnt: usize

owner: Option<String>

modify_policy: Option<ModifyPolicy>

permissions: Option<BlockPermissions>

Per-operation overrides of modify_policy. Omitted, the single policy governs every operation.

description: Option<String>

What the block is for, in prose, for an AI or a person reading the sheet later. A craft creating a block should say what it is for here.

analyzes: Option<usize>

Which block this one analyses, when it is an analysis block. Set here rather than in a follow-up payload so the block is never briefly a stray table — the whole creation lands as one transaction, and a reader between two payloads never sees a total row it would mistake for a record. See design/block-analysis.md.

pivot: Option<PivotSpecParts>

When the block is a PIVOT, the recipe its cells and its shape derive from. Requires analyzes: a pivot with no source is refused, because every cell of it would aggregate nothing. See design/block-pivot.md.

Trait Implementations

impl Clone for CreateBlock

fn clone(&self) -> CreateBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBlock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateBlock

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CreateBlock> for EditPayload

fn from(value: CreateBlock) -> EditPayload

Converts to this type from the input type.

impl From<_GentsDummyCreateBlock> for CreateBlock

fn from(value: _GentsDummyCreateBlock) -> CreateBlock

Converts to this type from the input type.

impl Payload for CreateBlock

impl Serialize for CreateBlock

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 CreateBlock

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

fn _ts_name() -> String

fn _is_optional() -> bool

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