Struct arrow_schema::ffi::FFI_ArrowSchema

#[repr(C)]
pub struct FFI_ArrowSchema { /* private fields */ }

ABI-compatible struct for ArrowSchema from C Data Interface See https://arrow.apache.org/docs/format/CDataInterface.html#structure-definitions

fn array_schema(data_type: &DataType) -> FFI_ArrowSchema {
    FFI_ArrowSchema::try_from(data_type).unwrap()
}

Implementations

impl FFI_ArrowSchema

pub fn try_new( format: &str, children: Vec<FFI_ArrowSchema>, dictionary: Option<FFI_ArrowSchema>, ) -> Result<Self, ArrowError>

create a new FFI_ArrowSchema. This fails if the fields’ DataType is not supported.

pub fn with_name(self, name: &str) -> Result<Self, ArrowError>

pub fn with_flags(self, flags: Flags) -> Result<Self, ArrowError>

pub fn with_metadata<I, S>(self, metadata: I) -> Result<Self, ArrowError>

where I: IntoIterator<Item = (S, S)>, S: AsRef<str>,

pub unsafe fn from_raw(schema: *mut FFI_ArrowSchema) -> Self

Takes ownership of the pointed to FFI_ArrowSchema

This acts to move the data out of schema, setting the release callback to NULL

Safety

• schema must be valid for reads and writes
• schema must be properly aligned
• schema must point to a properly initialized value of FFI_ArrowSchema

pub fn empty() -> Self

pub fn format(&self) -> &str

returns the format of this schema.

pub fn name(&self) -> &str

returns the name of this schema.

pub fn flags(&self) -> Option<Flags>

pub fn child(&self, index: usize) -> &Self

pub fn children(&self) -> impl Iterator<Item = &Self>

pub fn nullable(&self) -> bool

pub fn dictionary(&self) -> Option<&Self>

pub fn map_keys_sorted(&self) -> bool

pub fn dictionary_ordered(&self) -> bool

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

Trait Implementations

impl Debug for FFI_ArrowSchema

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

Formats the value using the given formatter.

impl Drop for FFI_ArrowSchema

fn drop(&mut self)

Executes the destructor for this type.

impl TryFrom<&Arc<Field>> for FFI_ArrowSchema

type Error = ArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&DataType> for FFI_ArrowSchema

fn try_from(dtype: &DataType) -> Result<Self, ArrowError>

See CDataInterface docs

type Error = ArrowError

The type returned in the event of a conversion error.

impl TryFrom<&FFI_ArrowSchema> for DataType

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

See CDataInterface docs

type Error = ArrowError

The type returned in the event of a conversion error.

impl TryFrom<&FFI_ArrowSchema> for Field

type Error = ArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&FFI_ArrowSchema> for Schema

type Error = ArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Field> for FFI_ArrowSchema

type Error = ArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Schema> for FFI_ArrowSchema

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from(schema: &Schema) -> Result<Self, ArrowError>

Performs the conversion.

impl TryFrom<DataType> for FFI_ArrowSchema

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from(dtype: DataType) -> Result<Self, ArrowError>

Performs the conversion.

impl TryFrom<Field> for FFI_ArrowSchema

type Error = ArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Schema> for FFI_ArrowSchema

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from(schema: Schema) -> Result<Self, ArrowError>

Performs the conversion.

impl Send for FFI_ArrowSchema