datafusion_functions/encoding/mod.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
18use datafusion_expr::ScalarUDF;
19use std::sync::Arc;
20
21pub mod inner;
22
23// create `encode` and `decode` UDFs
24make_udf_function!(inner::EncodeFunc, encode);
25make_udf_function!(inner::DecodeFunc, decode);
26
27// Export the functions out of this package, both as expr_fn as well as a list of functions
28pub mod expr_fn {
29 export_functions!( (
30 encode,
31 "encode the `input`, using the `encoding`. encoding can be base64 or hex",
32 input encoding
33 ),(
34 decode,
35 "decode the `input`, using the `encoding`. encoding can be base64 or hex",
36 input encoding
37 ));
38}
39
40/// Returns all DataFusion functions defined in this package
41pub fn functions() -> Vec<Arc<ScalarUDF>> {
42 vec![encode(), decode()]
43}