datafusion_ffi/
lib.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18#![doc(
19    html_logo_url = "https://raw.githubusercontent.com/apache/datafusion/19fe44cf2f30cbdd63d4a4f52c74055163c6cc38/docs/logos/standalone_logo/logo_original.svg",
20    html_favicon_url = "https://raw.githubusercontent.com/apache/datafusion/19fe44cf2f30cbdd63d4a4f52c74055163c6cc38/docs/logos/standalone_logo/logo_original.svg"
21)]
22#![cfg_attr(docsrs, feature(doc_cfg))]
23// Make sure fast / cheap clones on Arc are explicit:
24// https://github.com/apache/datafusion/issues/11143
25#![deny(clippy::clone_on_ref_ptr)]
26
27pub mod arrow_wrappers;
28pub mod catalog_provider;
29pub mod execution_plan;
30pub mod insert_op;
31pub mod plan_properties;
32pub mod record_batch_stream;
33pub mod schema_provider;
34pub mod session_config;
35pub mod table_provider;
36pub mod table_source;
37pub mod udaf;
38pub mod udf;
39pub mod udtf;
40pub mod udwf;
41pub mod util;
42pub mod volatility;
43
44#[cfg(feature = "integration-tests")]
45pub mod tests;
46
47/// Returns the major version of the FFI implementation. If the API evolves,
48/// we use the major version to identify compatibility over the unsafe
49/// boundary. This call is intended to be used by implementers to validate
50/// they have compatible libraries.
51pub extern "C" fn version() -> u64 {
52    let version_str = env!("CARGO_PKG_VERSION");
53    let version = semver::Version::parse(version_str).expect("Invalid version string");
54    version.major
55}
56
57#[cfg(doctest)]
58doc_comment::doctest!("../README.md", readme_example_test);
datafusion_ffi/lib.rs

datafusion_ffi/
lib.rs
