Struct Field

Source
pub struct Field {
    name: String,
    data_type: DataType,
    nullable: bool,
    dict_id: i64,
    dict_is_ordered: bool,
    metadata: HashMap<String, String>,
}
Expand description

Describes a single column in a Schema.

A Schema is an ordered collection of Field objects.

Fields§

§name: String§data_type: DataType§nullable: bool§dict_id: i64
👎Deprecated since 54.0.0: The ability to preserve dictionary IDs will be removed. With it, all fields related to it.
§dict_is_ordered: bool§metadata: HashMap<String, String>

A map of key-value pairs containing additional custom meta data.

Implementations§

Source§

impl Field

Source

pub const LIST_FIELD_DEFAULT_NAME: &'static str = "item"

Default list member field name

Source

pub fn new(name: impl Into<String>, data_type: DataType, nullable: bool) -> Self

Creates a new field with the given name, type, and nullability

Source

pub fn new_list_field(data_type: DataType, nullable: bool) -> Self

Creates a new Field suitable for DataType::List and DataType::LargeList

While not required, this method follows the convention of naming the Field "item".

§Example
assert_eq!(
  Field::new("item", DataType::Int32, true),
  Field::new_list_field(DataType::Int32, true)
);
Source

pub fn new_dict( name: impl Into<String>, data_type: DataType, nullable: bool, dict_id: i64, dict_is_ordered: bool, ) -> Self

👎Deprecated since 54.0.0: The ability to preserve dictionary IDs will be removed. With the dict_id field disappearing this function signature will change by removing the dict_id parameter.

Creates a new field that has additional dictionary information

Source

pub fn new_dictionary( name: impl Into<String>, key: DataType, value: DataType, nullable: bool, ) -> Self

Create a new Field with DataType::Dictionary

Use Self::new_dict for more advanced dictionary options

§Panics

Panics if !key.is_dictionary_key_type

Source

pub fn new_struct( name: impl Into<String>, fields: impl Into<Fields>, nullable: bool, ) -> Self

Create a new Field with DataType::Struct

Source

pub fn new_list( name: impl Into<String>, value: impl Into<FieldRef>, nullable: bool, ) -> Self

Create a new Field with DataType::List

Source

pub fn new_large_list( name: impl Into<String>, value: impl Into<FieldRef>, nullable: bool, ) -> Self

Create a new Field with DataType::LargeList

Source

pub fn new_fixed_size_list( name: impl Into<String>, value: impl Into<FieldRef>, size: i32, nullable: bool, ) -> Self

Create a new Field with DataType::FixedSizeList

Source

pub fn new_map( name: impl Into<String>, entries: impl Into<String>, keys: impl Into<FieldRef>, values: impl Into<FieldRef>, sorted: bool, nullable: bool, ) -> Self

Create a new Field with DataType::Map

Source

pub fn new_union<S, F, T>( name: S, type_ids: T, fields: F, mode: UnionMode, ) -> Self
where S: Into<String>, F: IntoIterator, F::Item: Into<FieldRef>, T: IntoIterator<Item = i8>,

Create a new Field with DataType::Union

  • name: the name of the DataType::Union field
  • type_ids: the union type ids
  • fields: the union fields
  • mode: the union mode
Source

pub fn set_metadata(&mut self, metadata: HashMap<String, String>)

Sets the Field’s optional custom metadata.

Source

pub fn with_metadata(self, metadata: HashMap<String, String>) -> Self

Sets the metadata of this Field to be metadata and returns self

Source

pub const fn metadata(&self) -> &HashMap<String, String>

Returns the immutable reference to the Field’s optional custom metadata.

Source

pub const fn name(&self) -> &String

Returns an immutable reference to the Field’s name.

Source

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

Set the name of the Field and returns self.

let field = Field::new("c1", DataType::Int64, false)
   .with_name("c2");

assert_eq!(field.name(), "c2");
Source

pub const fn data_type(&self) -> &DataType

Returns an immutable reference to the Field’s DataType.

Source

pub fn with_data_type(self, data_type: DataType) -> Self

Set DataType of the Field and returns self.

let field = Field::new("c1", DataType::Int64, false)
   .with_data_type(DataType::Utf8);

assert_eq!(field.data_type(), &DataType::Utf8);
Source

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

Returns the extension type name of this Field, if set.

This returns the value of EXTENSION_TYPE_NAME_KEY, if set in Field::metadata. If the key is missing, there is no extension type name and this returns None.

§Example

let field = Field::new("", DataType::Null, false);
assert_eq!(field.extension_type_name(), None);

let field = Field::new("", DataType::Null, false).with_metadata(
   [(EXTENSION_TYPE_NAME_KEY.to_owned(), "example".to_owned())]
       .into_iter()
       .collect(),
);
assert_eq!(field.extension_type_name(), Some("example"));
Source

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

Returns the extension type metadata of this Field, if set.

This returns the value of EXTENSION_TYPE_METADATA_KEY, if set in Field::metadata. If the key is missing, there is no extension type metadata and this returns None.

§Example

let field = Field::new("", DataType::Null, false);
assert_eq!(field.extension_type_metadata(), None);

let field = Field::new("", DataType::Null, false).with_metadata(
   [(EXTENSION_TYPE_METADATA_KEY.to_owned(), "example".to_owned())]
       .into_iter()
       .collect(),
);
assert_eq!(field.extension_type_metadata(), Some("example"));
Source

pub fn try_extension_type<E: ExtensionType>(&self) -> Result<E, ArrowError>

Returns an instance of the given ExtensionType of this Field, if set in the Field::metadata.

§Error

Returns an error if

Source

pub fn extension_type<E: ExtensionType>(&self) -> E

Returns an instance of the given ExtensionType of this Field, panics if this Field does not have this extension type.

§Panic

This calls Field::try_extension_type and panics when it returns an error.

Source

pub fn try_with_extension_type<E: ExtensionType>( &mut self, extension_type: E, ) -> Result<(), ArrowError>

Updates the metadata of this Field with the ExtensionType::NAME and ExtensionType::metadata of the given ExtensionType, if the given extension type supports the Field::data_type of this field (ExtensionType::supports_data_type).

If the given extension type defines no metadata, a previously set value of EXTENSION_TYPE_METADATA_KEY is cleared.

§Error

This functions returns an error if the data type of this field does not match any of the supported storage types of the given extension type.

Source

pub fn with_extension_type<E: ExtensionType>(self, extension_type: E) -> Self

Updates the metadata of this Field with the ExtensionType::NAME and ExtensionType::metadata of the given ExtensionType.

§Panics

This calls Field::try_with_extension_type and panics when it returns an error.

Source

pub fn try_canonical_extension_type( &self, ) -> Result<CanonicalExtensionType, ArrowError>

Returns the CanonicalExtensionType of this Field, if set.

§Error

Returns an error if

  • this field does have a canonical extension type (mismatch or missing)
  • the canonical extension is not supported
  • the construction of the extension type fails
Source

pub const fn is_nullable(&self) -> bool

Indicates whether this Field supports null values.

Source

pub fn with_nullable(self, nullable: bool) -> Self

Set nullable of the Field and returns self.

let field = Field::new("c1", DataType::Int64, false)
   .with_nullable(true);

assert_eq!(field.is_nullable(), true);
Source

pub(crate) fn fields(&self) -> Vec<&Field>

Returns a (flattened) Vec containing all child Fields within self contained within this field (including self)

Source

fn _fields(dt: &DataType) -> Vec<&Field>

Source

pub(crate) fn fields_with_dict_id(&self, id: i64) -> Vec<&Field>

👎Deprecated since 54.0.0: The ability to preserve dictionary IDs will be removed. With it, all fields related to it.

Returns a vector containing all (potentially nested) Field instances selected by the dictionary ID they use

Source

pub const fn dict_id(&self) -> Option<i64>

👎Deprecated since 54.0.0: The ability to preserve dictionary IDs will be removed. With it, all fields related to it.

Returns the dictionary ID, if this is a dictionary type.

Source

pub const fn dict_is_ordered(&self) -> Option<bool>

Returns whether this Field’s dictionary is ordered, if this is a dictionary type.

§Example
// non dictionaries do not have a dict is ordered flat
let field = Field::new("c1", DataType::Int64, false);
assert_eq!(field.dict_is_ordered(), None);
// by default dictionary is not ordered
let field = Field::new("c1", DataType::Dictionary(Box::new(DataType::Int64), Box::new(DataType::Utf8)), false);
assert_eq!(field.dict_is_ordered(), Some(false));
let field = field.with_dict_is_ordered(true);
assert_eq!(field.dict_is_ordered(), Some(true));
Source

pub fn with_dict_is_ordered(self, dict_is_ordered: bool) -> Self

Set the is ordered field for this Field, if it is a dictionary.

Does nothing if this is not a dictionary type.

See Field::dict_is_ordered for more information.

Source

pub fn try_merge(&mut self, from: &Field) -> Result<(), ArrowError>

Merge this field into self if it is compatible.

Struct fields are merged recursively.

NOTE: self may be updated to a partial / unexpected state in case of merge failure.

Example:

let mut field = Field::new("c1", DataType::Int64, false);
assert!(field.try_merge(&Field::new("c1", DataType::Int64, true)).is_ok());
assert!(field.is_nullable());
Source

pub fn contains(&self, other: &Field) -> bool

Check to see if self is a superset of other field. Superset is defined as:

  • if nullability doesn’t match, self needs to be nullable
  • self.metadata is a superset of other.metadata
  • all other fields are equal
Source

pub fn size(&self) -> usize

Return size of this instance in bytes.

Includes the size of Self.

Trait Implementations§

Source§

impl Clone for Field

Source§

fn clone(&self) -> Field

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Field

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Field

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Field

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Extend<Field> for SchemaBuilder

Source§

fn extend<T: IntoIterator<Item = Field>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl FromIterator<Field> for Fields

Source§

fn from_iter<T: IntoIterator<Item = Field>>(iter: T) -> Self

Creates a value from an iterator. Read more
Source§

impl Hash for Field

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Field

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Field

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Field

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for Field

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<&FFI_ArrowSchema> for Field

Source§

type Error = ArrowError

The type returned in the event of a conversion error.
Source§

fn try_from(c_schema: &FFI_ArrowSchema) -> Result<Self, ArrowError>

Performs the conversion.
Source§

impl TryFrom<&Field> for CanonicalExtensionType

Source§

type Error = ArrowError

The type returned in the event of a conversion error.
Source§

fn try_from(value: &Field) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<&Field> for FFI_ArrowSchema

Source§

type Error = ArrowError

The type returned in the event of a conversion error.
Source§

fn try_from(field: &Field) -> Result<Self, ArrowError>

Performs the conversion.
Source§

impl TryFrom<Field> for FFI_ArrowSchema

Source§

type Error = ArrowError

The type returned in the event of a conversion error.
Source§

fn try_from(field: Field) -> Result<Self, ArrowError>

Performs the conversion.
Source§

impl Eq for Field

Auto Trait Implementations§

§

impl Freeze for Field

§

impl RefUnwindSafe for Field

§

impl Send for Field

§

impl Sync for Field

§

impl Unpin for Field

§

impl UnwindSafe for Field

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,