Struct IcebergStructField 

#[non_exhaustive]
pub struct IcebergStructField {
    pub id: i32,
    pub name: String,
    pub type: Document,
    pub required: bool,
    pub doc: Option<String>,
    pub initial_default: Option<Document>,
    pub write_default: Option<Document>,
}

Defines a single field within an Iceberg table schema, including its identifier, name, data type, nullability, and documentation.

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.

id: i32

The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.

name: String

The name of the field as it appears in the table schema and query operations.

type: Document

The data type definition for this field, specifying the structure and format of the data it contains.

required: bool

Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.

doc: Option<String>

Optional documentation or description text that provides additional context about the purpose and usage of this field.

initial_default: Option<Document>

Default value used to populate the field's value for all records that were written before the field was added to the schema. This enables backward compatibility when adding new fields to existing Iceberg tables.

write_default: Option<Document>

Default value used to populate the field's value for any records written after the field was added to the schema, if the writer does not supply the field's value. This can be changed through schema evolution.

Implementations

impl IcebergStructField

pub fn id(&self) -> i32

The unique identifier assigned to this field within the Iceberg table schema, used for schema evolution and field tracking.

pub fn name(&self) -> &str

The name of the field as it appears in the table schema and query operations.

pub fn type(&self) -> &Document

The data type definition for this field, specifying the structure and format of the data it contains.

pub fn required(&self) -> bool

Indicates whether this field is required (non-nullable) or optional (nullable) in the table schema.

pub fn doc(&self) -> Option<&str>

Optional documentation or description text that provides additional context about the purpose and usage of this field.

pub fn initial_default(&self) -> Option<&Document>

Default value used to populate the field's value for all records that were written before the field was added to the schema. This enables backward compatibility when adding new fields to existing Iceberg tables.

pub fn write_default(&self) -> Option<&Document>

Default value used to populate the field's value for any records written after the field was added to the schema, if the writer does not supply the field's value. This can be changed through schema evolution.

impl IcebergStructField

pub fn builder() -> IcebergStructFieldBuilder

Creates a new builder-style object to manufacture IcebergStructField.

Trait Implementations

impl Clone for IcebergStructField

fn clone(&self) -> IcebergStructField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IcebergStructField

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

Formats the value using the given formatter.

impl PartialEq for IcebergStructField

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