Struct iceberg::spec::NestedField

pub struct NestedField {
    pub id: i32,
    pub name: String,
    pub required: bool,
    pub field_type: Box<Type>,
    pub doc: Option<String>,
    pub initial_default: Option<Literal>,
    pub write_default: Option<Literal>,
}

A struct is a tuple of typed values. Each field in the tuple is named and has an integer id that is unique in the table schema. Each field can be either optional or required, meaning that values can (or cannot) be null. Fields may be any type. Fields may have an optional comment or doc string. Fields can have default values.

Fields

id: i32

Id unique in table schema

name: String

Field Name

required: bool

Optional or required

field_type: Box<Type>

Datatype

doc: Option<String>

Fields may have an optional comment or doc string.

initial_default: Option<Literal>

Used to populate the field’s value for all records that were written before the field was added to the schema

write_default: Option<Literal>

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

Implementations

impl NestedField

pub fn new( id: i32, name: impl ToString, field_type: Type, required: bool, ) -> Self

Construct a new field.

pub fn required(id: i32, name: impl ToString, field_type: Type) -> Self

Construct a required field.

pub fn optional(id: i32, name: impl ToString, field_type: Type) -> Self

Construct an optional field.

pub fn list_element(id: i32, field_type: Type, required: bool) -> Self

Construct list type’s element field.

pub fn map_key_element(id: i32, field_type: Type) -> Self

Construct map type’s key field.

pub fn map_value_element(id: i32, field_type: Type, required: bool) -> Self

Construct map type’s value field.

pub fn with_doc(self, doc: impl ToString) -> Self

Set the field’s doc.

pub fn with_initial_default(self, value: Literal) -> Self

Set the field’s initial default value.

pub fn with_write_default(self, value: Literal) -> Self

Set the field’s initial default value.

Trait Implementations

impl Clone for NestedField

fn clone(&self) -> NestedField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NestedField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NestedField

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NestedField

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

Formats the value using the given formatter.

impl PartialEq for NestedField

fn eq(&self, other: &NestedField) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NestedField

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for NestedField

impl StructuralPartialEq for NestedField