opendal-core 0.56.0

Apache OpenDAL™: One Layer, All Storage.
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

// 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 std::future::Future;
use std::ops::DerefMut;

use crate::raw::oio::Entry;
use crate::raw::*;
use crate::*;

/// The boxed version of [`List`]
pub type Lister = Box<dyn ListDyn>;

/// Page trait is used by [`raw::Accessor`] to implement `list` operation.
pub trait List: Unpin + Send + Sync {
    /// Fetch a new page of [`Entry`]
    ///
    /// `Ok(None)` means all pages have been returned. Any following call
    /// to `next` will always get the same result.
    fn next(&mut self) -> impl Future<Output = Result<Option<Entry>>> + MaybeSend;
}

impl List for () {
    async fn next(&mut self) -> Result<Option<Entry>> {
        Ok(None)
    }
}

impl<P: List> List for Option<P> {
    async fn next(&mut self) -> Result<Option<Entry>> {
        match self {
            Some(p) => p.next().await,
            None => Ok(None),
        }
    }
}

/// ListDyn is the dyn version of [`List`]. Makes it possible to use as
/// `Box<dyn ListDyn>`.
pub trait ListDyn: Unpin + Send + Sync {
    /// The dyn version of [`List::next`].
    fn next_dyn(&mut self) -> BoxedFuture<'_, Result<Option<Entry>>>;
}

impl<T: List + ?Sized> ListDyn for T {
    fn next_dyn(&mut self) -> BoxedFuture<'_, Result<Option<Entry>>> {
        Box::pin(self.next())
    }
}

impl<T: ListDyn + ?Sized> List for Box<T> {
    async fn next(&mut self) -> Result<Option<Entry>> {
        self.deref_mut().next_dyn().await
    }
}