arrow_array/nonblocking.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//! Trait definitions specific to using Arrow with async.
19
20use arrow_schema::{ArrowError, SchemaRef};
21
22use crate::record_batch::RecordBatch;
23
24/// Trait for an asynchronous stream of `RecordBatch`es.
25pub trait RecordBatchStream: futures::Stream<Item = Result<RecordBatch, ArrowError>> {
26 /// Return the schema of this `RecordBatchStream`.
27 ///
28 /// Implementation of this trait should guarantee that all `RecordBatch`'s returned by this
29 /// reader should have the same schema as returned from this method.
30 fn schema(&self) -> &SchemaRef;
31}