Struct ObjectList

#[non_exhaustive]
pub struct ObjectList<P: PointerFamily = ArcPointer, Item = Object<P>> { /* private fields */ }

存放对象列表的结构体

before name is ObjectList TODO impl core::ops::Index

Implementations

impl<T: PointerFamily, Item> ObjectList<T, Item>

pub fn new<Q: IntoIterator<Item = (QueryKey, QueryValue)>>( bucket: BucketBase, prefix: Option<ObjectDir<'static>>, max_keys: u32, key_count: u64, object_list: Vec<Item>, next_continuation_token: Option<String>, client: T::PointerType, search_query: Q, ) -> Self

文件列表的初始化方法

pub fn bucket(&self) -> &BucketBase

返回 bucket 元信息的引用

pub fn prefix(&self) -> &Option<ObjectDir<'static>>

返回 prefix 的引用

pub fn common_prefixes(&self) -> &CommonPrefixes

获取文件夹下的子文件夹名，子文件夹下递归的所有文件和文件夹不包含在这里。

pub fn set_common_prefixes<P: IntoIterator<Item = ObjectDir<'static>>>( &mut self, prefixes: P, )

设置 common_prefixes 信息

pub fn max_keys(&self) -> &u32

返回 max_keys

pub fn key_count(&self) -> &u64

返回 key_count

pub fn next_continuation_token_str(&self) -> &String

返回下一个 continuation_token

用于翻页使用

pub fn search_query(&self) -> &Query

返回查询条件

pub fn next_query(&self) -> Option<Query>

下一页的查询条件

如果有下一页，返回 Some(Query) 如果没有下一页，则返回 None

pub fn object_iter(self) -> IntoIter<Item>

将 object 列表转化为迭代器

impl ObjectList<ArcPointer>

pub async fn get_next_list( &self, ) -> Result<ObjectList<ArcPointer>, ExtractListError>

异步获取下一页的数据 TODO 改为 unstable

pub fn into_stream(self) -> impl Stream<Item = Result<Self, ExtractListError>>

将 object_list 转化为 stream, 返回第二页，第三页… 的内容

不够完善，最后一次迭代返回的是 Some(Err(OssError::WithoutMore))，而不是 None

用法

1. 添加依赖

[dependencies]
futures="0.3"

2. 将返回结果 pin 住

use futures::{pin_mut, StreamExt};
let stream = object_list.into_stream();
pin_mut!(stream);

let second_list = stream.next().await;
let third_list = stream.next().await;
println!("second_list: {:?}", second_list);
println!("third_list: {:?}", third_list);

impl<Item> ObjectList<ArcPointer, Item>

where Self: InitObject<Item>,

pub async fn get_next_base<E>( &mut self, ) -> Option<Result<Self, ExtractListError>>

where Item: RefineObject<E>, E: Error + 'static,

自定义 Item 时，获取下一页数据

当没有下一页查询条件时 返回 None 否则尝试获取下一页数据，成功返回 Some(Ok(_)), 失败返回 Some(Err(_))

impl ObjectList<RcPointer>

pub fn get_object_list(&self) -> Result<Self, ExtractListError>

从 OSS 获取 object 列表信息

impl<T: PointerFamily, Item> ObjectList<T, Item>

pub fn set_search_query(&mut self, search_query: Query)

设置查询条件

pub fn set_bucket(&mut self, bucket: BucketBase)

设置 bucket 元信息

pub fn bucket_name(&self) -> &str

获取 bucket 名称

pub fn to_vec(self) -> Vec<Item>

返回 object 的 Vec 集合

pub fn len(&self) -> usize

返回文件数量

pub fn is_empty(&self) -> bool

返回是否存在文件

Trait Implementations

impl<Item: Send + Sync> AlignBuilder for ObjectList<ArcPointer, Item>

fn builder_with_header<H: IntoIterator<Item = (HeaderName, HeaderValue)>>( &self, method: Method, url: Url, resource: CanonicalizedResource, headers: H, ) -> Result<RequestBuilder, BuilderError>

根据具体的 API 接口参数，返回请求的构建器

fn builder( &self, method: Method, url: Url, resource: CanonicalizedResource, ) -> Result<RequestBuilder, BuilderError>

根据具体的 API 接口参数，返回请求的构建器（不带 headers）

impl AlignBuilder for ObjectList<RcPointer>

fn builder_with_header<H: IntoIterator<Item = (HeaderName, HeaderValue)>>( &self, method: Method, url: Url, resource: CanonicalizedResource, headers: H, ) -> Result<RequestBuilder, BuilderError>

根据具体的 API 接口参数，返回请求的构建器

fn builder( &self, method: Method, url: Url, resource: CanonicalizedResource, ) -> Result<RequestBuilder, BuilderError>

根据具体的 API 接口参数，返回请求的构建器（不带 headers）

impl<T: PointerFamily, Item> AsMut<Query> for ObjectList<T, Item>

fn as_mut(&mut self) -> &mut Query

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: PointerFamily, Item> AsRef<BucketBase> for ObjectList<T, Item>

fn as_ref(&self) -> &BucketBase

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: PointerFamily, Item> AsRef<BucketName> for ObjectList<T, Item>

fn as_ref(&self) -> &BucketName

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: PointerFamily, Item> AsRef<EndPoint> for ObjectList<T, Item>

fn as_ref(&self) -> &EndPoint

Converts this type into a shared reference of the (usually inferred) input type.

impl<P: Clone + PointerFamily, Item: Clone> Clone for ObjectList<P, Item>

where P::PointerType: Clone,

fn clone(&self) -> ObjectList<P, Item>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: PointerFamily, Item> Debug for ObjectList<T, Item>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P: PointerFamily, Item> Default for ObjectList<P, Item>

fn default() -> Self

Returns the “default value” for a type.

impl<Item: RefineObject<BuildInItemError> + Send + Sync, U: GetStd> GetStdWithPath<U> for ObjectList<ArcPointer, Item>

用于在 ObjectList 上对文件进行操作

文件路径可以是实现 GetStd 特征的类型

TODO remove Send + Sync

fn get_std_with_path(&self, path: U) -> Option<(Url, CanonicalizedResource)>

根据 path 获取 Url 和 CanonicalizedResource

impl InitObject<Object<RcPointer>> for ObjectList<RcPointer, Object<RcPointer>>

fn init_object(&mut self) -> Option<Object<RcPointer>>

初始化 object 的类型

impl InitObject<Object> for ObjectList<ArcPointer, Object<ArcPointer>>

fn init_object(&mut self) -> Option<Object<ArcPointer>>

初始化 object 的类型

impl Iterator for ObjectList<RcPointer>

type Item = ObjectList<RcPointer>

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self>

Advances the iterator and returns the next value.

fn next_chunk<const N: usize>( &mut self, ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)

Advances the iterator and returns an array containing the next N values.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usize

where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

where Self: Sized,

Consumes the iterator, returning the last element.

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

fn step_by(self, step: usize) -> StepBy<Self>

where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs.

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>

where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places an item generated by separator between adjacent items of the original iterator.

fn map<B, F>(self, f: F) -> Map<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element.

fn for_each<F>(self, f: F)

where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator.

fn filter<P>(self, predicate: P) -> Filter<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate.

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>

where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps.

fn skip(self, n: usize) -> Skip<Self>

where Self: Sized,

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>

where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>

where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>

where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure.

fn flatten(self) -> Flatten<Self>

where Self: Sized, Self::Item: IntoIterator,

Creates an iterator that flattens nested structure.

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>

where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows)

Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well.

fn fuse(self) -> Fuse<Self>

where Self: Sized,

Creates an iterator which ends after the first None.

fn inspect<F>(self, f: F) -> Inspect<Self, F>

where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Iterator.

fn collect<B>(self) -> B

where B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection.

fn collect_into<E>(self, collection: &mut E) -> &mut E

where E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)

Collects all the items from an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B)

where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it.

fn is_partitioned<P>(self, predicate: P) -> bool

where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_is_partitioned)

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false.

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R

where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value.

fn try_for_each<F, R>(&mut self, f: F) -> R

where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

fn fold<B, F>(self, init: B, f: F) -> B

where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result.

fn reduce<F>(self, f: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation.

fn try_reduce<R>( &mut self, f: impl FnMut(Self::Item, Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType

where Self: Sized, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce)

Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately.

fn all<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate.

fn find_map<B, F>(&mut self, f: F) -> Option<B>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result.

fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType

where Self: Sized, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find)

Applies function to the elements of iterator and returns the first true result or the first error.

fn position<P>(&mut self, predicate: P) -> Option<usize>

where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function.

fn max_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function.

fn min_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)

where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers.

fn copied<'a, T>(self) -> Copied<Self>

where T: 'a + Copy, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements.

fn cloned<'a, T>(self) -> Cloned<Self>

where T: 'a + Clone, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements.

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)

Returns an iterator over N elements of the iterator at a time.

fn sum<S>(self) -> S

where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator.

fn product<P>(self) -> P

where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn partial_cmp<I>(self, other: I) -> Option<Ordering>

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned.

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn eq<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another.

fn eq_by<I, F>(self, other: I, eq: F) -> bool

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_order_by)

Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function.

fn ne<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another.

fn lt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

fn is_sorted_by<F>(self, compare: F) -> bool

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

Checks if the elements of this iterator are sorted using the given comparator function.

fn is_sorted_by_key<F, K>(self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

Checks if the elements of this iterator are sorted using the given key extraction function.

impl<P: PointerFamily, Item: RefineObject<E>, E: Error + 'static> RefineObjectList<Item, ObjectListError, E> for ObjectList<P, Item>

fn set_key_count(&mut self, key_count: &str) -> Result<(), ObjectListError>

提取 key_count

fn set_prefix(&mut self, prefix: &str) -> Result<(), ObjectListError>

提取前缀

fn set_common_prefix( &mut self, list: &[Cow<'_, str>], ) -> Result<(), ObjectListError>

提取文件目录

fn set_max_keys(&mut self, max_keys: &str) -> Result<(), ObjectListError>

提取 max_keys

fn set_next_continuation_token_str( &mut self, token: &str, ) -> Result<(), ObjectListError>

提取翻页信息 token

fn set_list(&mut self, list: Vec<Item>) -> Result<(), ObjectListError>

提取 object 列表

fn set_name(&mut self, _name: &str) -> Result<(), Error>

提取 bucket 名

fn decode_common_prefix(&mut self, xml: &str) -> Result<(), InnerListError>

用于解析 common prefix

fn decode<F>(&mut self, xml: &str, init_object: F) -> Result<(), InnerListError>

where F: for<'a> Fn(&'a mut Self) -> Option<T>,

由 xml 转 struct 的底层实现