Struct StructType

pub struct StructType { /* private fields */ }

Representation of a Spark StructType

Used to create the a schema with other DataType

Example:

let schema = StructType::new(vec![
       StructField {
            name: "name",
            data_type: DataType::String,
            nullable: false,
            metadata: None,
        },
        StructField {
            name: "age",
            data_type: DataType::Short,
            nullable: true,
            metadata: None,
        },
    ]);

Complex types are also supported. The example below creates an DataType::Array that contains a two StructField.

Example:

let complex_schema = DataType::Array {
        element_type: Box::new(DataType::Struct(Box::new(StructType::new(vec![
            StructField {
                name: "col5",
                data_type: DataType::String,
                nullable: true,
                metadata: None,
            },
            StructField {
                name: "col6",
                data_type: DataType::Char(200),
                nullable: true,
                metadata: None,
            },
        ])))),
        contains_null: true,
    };

Implementations

impl StructType

pub fn empty() -> Self

Create an empty StructType

pub fn new(fields: Vec<StructField>) -> Self

Create a new StructType from a vector of StructField

pub fn fields(&self) -> Vec<StructField>

pub fn append(self, field: StructField) -> Self

Append a new field onto the exist fields

Trait Implementations

impl Clone for StructType

fn clone(&self) -> StructType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructType

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

Formats the value using the given formatter.

impl From<StructType> for DataType

fn from(value: StructType) -> DataType

Converts to this type from the input type.

impl SparkDataType for StructType

fn type_name(&self) -> String

fn as_str_name(&self) -> String

fn json(&self) -> String

JSON representation of the object

fn json_value(&self) -> String

impl ToSchema for StructType

fn to_schema(&self) -> String