datafusion-ffi 53.1.0

Foreign Function Interface implementation for DataFusion
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

use abi_stable::StableAbi;
use arrow_schema::SortOptions;
use datafusion_common::DataFusionError;
use datafusion_expr::sort_properties::{ExprProperties, SortProperties};

use crate::expr::interval::FFI_Interval;

/// A stable struct for sharing [`ExprProperties`] across FFI boundaries.
/// See [`ExprProperties`] for the meaning of each field.
#[repr(C)]
#[derive(Debug, StableAbi)]
pub struct FFI_ExprProperties {
    sort_properties: FFI_SortProperties,
    range: FFI_Interval,
    preserves_lex_ordering: bool,
}

impl TryFrom<&ExprProperties> for FFI_ExprProperties {
    type Error = DataFusionError;
    fn try_from(value: &ExprProperties) -> Result<Self, Self::Error> {
        let sort_properties = (&value.sort_properties).into();
        let range = value.range.clone().try_into()?;

        Ok(FFI_ExprProperties {
            sort_properties,
            range,
            preserves_lex_ordering: value.preserves_lex_ordering,
        })
    }
}

impl TryFrom<FFI_ExprProperties> for ExprProperties {
    type Error = DataFusionError;
    fn try_from(value: FFI_ExprProperties) -> Result<Self, Self::Error> {
        let sort_properties = (&value.sort_properties).into();
        let range = value.range.try_into()?;
        Ok(ExprProperties {
            sort_properties,
            range,
            preserves_lex_ordering: value.preserves_lex_ordering,
        })
    }
}

#[repr(C)]
#[derive(Debug, StableAbi)]
pub enum FFI_SortProperties {
    Ordered(FFI_SortOptions),
    Unordered,
    Singleton,
}

impl From<&SortProperties> for FFI_SortProperties {
    fn from(value: &SortProperties) -> Self {
        match value {
            SortProperties::Unordered => FFI_SortProperties::Unordered,
            SortProperties::Singleton => FFI_SortProperties::Singleton,
            SortProperties::Ordered(o) => FFI_SortProperties::Ordered(o.into()),
        }
    }
}

impl From<&FFI_SortProperties> for SortProperties {
    fn from(value: &FFI_SortProperties) -> Self {
        match value {
            FFI_SortProperties::Unordered => SortProperties::Unordered,
            FFI_SortProperties::Singleton => SortProperties::Singleton,
            FFI_SortProperties::Ordered(o) => SortProperties::Ordered(o.into()),
        }
    }
}

#[repr(C)]
#[derive(Debug, StableAbi)]
pub struct FFI_SortOptions {
    pub descending: bool,
    pub nulls_first: bool,
}

impl From<&SortOptions> for FFI_SortOptions {
    fn from(value: &SortOptions) -> Self {
        Self {
            descending: value.descending,
            nulls_first: value.nulls_first,
        }
    }
}

impl From<&FFI_SortOptions> for SortOptions {
    fn from(value: &FFI_SortOptions) -> Self {
        Self {
            descending: value.descending,
            nulls_first: value.nulls_first,
        }
    }
}