Struct BlockSchema 

pub struct BlockSchema {
    pub name: String,
    pub schema_type: BlockSchemaType,
    pub keys: Vec<BlockSchemaKeyEntry>,
    pub fields: Vec<BlockSchemaFieldEntry>,
    pub random_entries: Vec<BlockSchemaRandomEntry>,
    pub header_idx: Option<usize>,
    pub key_idx: Option<usize>,
    pub unique_together: Vec<UniqueTogetherGroup>,
}

Fields

name: String

schema_type: BlockSchemaType

keys: Vec<BlockSchemaKeyEntry>

fields: Vec<BlockSchemaFieldEntry>

random_entries: Vec<BlockSchemaRandomEntry>

header_idx: Option<usize>

Block-relative index of the line holding field NAMES rather than a record, when the schema declares one.

An INDEX rather than the line id the schema stores, because a host counts lines from the block’s corner and has no business knowing line ids. Absent for the blocks that have no header line, which is most.

key_idx: Option<usize>

Block-relative index of the KEY line, on the same axis fields are numbered on: the key COLUMN of a row schema, the key ROW of a column schema.

Comparable with BlockSchemaFieldEntry::idx, and deliberately NOT with BlockSchemaKeyEntry::idx, which counts along the RECORD axis — see api::worksheet::key_index for what conflating the two cost. None only for a random schema, which has no key axis.

unique_together: Vec<UniqueTogetherGroup>

Field groups whose values must not repeat in COMBINATION — the block’s own rule, as opposed to the per-field ones on each entry.

Trait Implementations

impl Clone for BlockSchema

fn clone(&self) -> BlockSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockSchema

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<_GentsDummyBlockSchema> for BlockSchema

fn from(value: _GentsDummyBlockSchema) -> BlockSchema

Converts to this type from the input type.

impl Serialize for BlockSchema

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 BlockSchema

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

fn _ts_name() -> String

fn _is_optional() -> bool

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