arrow/array/validate.h

0001 // Licensed to the Apache Software Foundation (ASF) under one
0002 // or more contributor license agreements.  See the NOTICE file
0003 // distributed with this work for additional information
0004 // regarding copyright ownership.  The ASF licenses this file
0005 // to you under the Apache License, Version 2.0 (the
0006 // "License"); you may not use this file except in compliance
0007 // with the License.  You may obtain a copy of the License at
0008 //
0009 //   http://www.apache.org/licenses/LICENSE-2.0
0010 //
0011 // Unless required by applicable law or agreed to in writing,
0012 // software distributed under the License is distributed on an
0013 // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
0014 // KIND, either express or implied.  See the License for the
0015 // specific language governing permissions and limitations
0016 // under the License.
0017
0018 #pragma once
0019
0020 #include "arrow/status.h"
0021 #include "arrow/type_fwd.h"
0022 #include "arrow/util/visibility.h"
0023
0024 namespace arrow {
0025 namespace internal {
0026
0027 // Internal functions implementing Array::Validate() and friends.
0028
0029 // O(1) array metadata validation
0030
0031 ARROW_EXPORT
0032 Status ValidateArray(const Array& array);
0033
0034 ARROW_EXPORT
0035 Status ValidateArray(const ArrayData& data);
0036
0037 // O(N) array data validation.
0038 // Note that, starting from 7.0.0, "full" routines also validate metadata.
0039 // Before, ValidateArray() needed to be called before ValidateArrayFull()
0040 // to ensure metadata correctness, otherwise invalid memory accesses
0041 // may occur.
0042
0043 ARROW_EXPORT
0044 Status ValidateArrayFull(const Array& array);
0045
0046 ARROW_EXPORT
0047 Status ValidateArrayFull(const ArrayData& data);
0048
0049 ARROW_EXPORT
0050 Status ValidateUTF8(const Array& array);
0051
0052 ARROW_EXPORT
0053 Status ValidateUTF8(const ArrayData& data);
0054
0055 }  // namespace internal
0056 }  // namespace arrow