Struct IcebergStructFieldBuilder 

#[non_exhaustive]
pub struct IcebergStructFieldBuilder { /* private fields */ }

A builder for IcebergStructField.

Implementations

impl IcebergStructFieldBuilder

pub fn id(self, input: i32) -> Self

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

This field is required.

pub fn set_id(self, input: Option<i32>) -> Self

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

pub fn get_id(&self) -> &Option<i32>

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

pub fn name(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

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

pub fn get_name(&self) -> &Option<String>

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

pub fn type(self, input: Document) -> Self

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

This field is required.

pub fn set_type(self, input: Option<Document>) -> Self

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

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

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

pub fn required(self, input: bool) -> Self

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

This field is required.

pub fn set_required(self, input: Option<bool>) -> Self

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

pub fn get_required(&self) -> &Option<bool>

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

pub fn doc(self, input: impl Into<String>) -> Self

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

pub fn set_doc(self, input: Option<String>) -> Self

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

pub fn get_doc(&self) -> &Option<String>

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

pub fn initial_default(self, input: Document) -> Self

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 set_initial_default(self, input: Option<Document>) -> Self

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 get_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, input: Document) -> Self

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.

pub fn set_write_default(self, input: Option<Document>) -> Self

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.

pub fn get_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.

pub fn build(self) -> Result<IcebergStructField, BuildError>

Consumes the builder and constructs a IcebergStructField. This method will fail if any of the following fields are not set:

• name
• r#type

Trait Implementations

impl Clone for IcebergStructFieldBuilder

fn clone(&self) -> IcebergStructFieldBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IcebergStructFieldBuilder

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

Formats the value using the given formatter.

impl Default for IcebergStructFieldBuilder

fn default() -> IcebergStructFieldBuilder

Returns the “default value” for a type.

impl PartialEq for IcebergStructFieldBuilder

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