Struct s3_algo::ListObjects

pub struct ListObjects<C, S> { /* private fields */ }

A stream that can list objects, and (using member functions) delete or copy listed files.

Implementations

impl<C, S> ListObjects<C, S>where
    C: S3 + Clone + Send + Sync + Unpin + 'static,
    S: Stream<Item = ListObjectsV2Result> + Sized + Send + 'static,

pub fn boxed(
    self
) -> ListObjects<C, Pin<Box<dyn Stream<Item = ListObjectsV2Result> + Send>>>

pub async fn process<P, F>(self, f: P) -> Result<(), Error>where
    P: Fn(Object) -> F + Clone,
    F: Future<Output = ()>,

Calls an async closure on all the individual objects of the list operation

pub fn download_all_stream<R>(
    self,
    default_request: R
) -> impl Stream<Item = Result<(String, ByteStream), Error>>where
    R: Fn() -> GetObjectRequest + Clone + Unpin + Sync + Send + 'static,

Download all listed objects - returns a stream of the contents. Used as a basis for other download_all_* functions.

pub fn download_all_to_vec<R>(
    self,
    default_request: R
) -> impl Stream<Item = Result<(String, Vec<u8>), Error>>where
    R: Fn() -> GetObjectRequest + Clone + Unpin + Sync + Send + 'static,

pub fn delete_all<P1, P2, F1, F2>(
    self,
    list_progress: P1,
    delete_progress: P2
) -> impl Future<Output = Result<(), Error>>where
    P1: Fn(RequestReport) -> F1 + Clone + Send + Sync + 'static,
    P2: Fn(RequestReport) -> F2 + Clone + Send + Sync + 'static,
    F1: Future<Output = ()> + Send + 'static,
    F2: Future<Output = ()> + Send + 'static,

Delete all listed objects.

The progress closure

The second (bool) argument says whether it’s about a List or Delete request:

• false: ListObjectsV2 request
• true: DeleteObjects request

pub fn flatten(self) -> impl Stream<Item = Result<Object, Error>>

Flatten into a stream of Objects.

pub fn copy_all<F, R>(
    self,
    dest_bucket: Option<String>,
    mapping: F,
    default_request: R
) -> impl Future<Output = Result<(), Error>>where
    F: Fn(&str) -> String + Clone + Send + Sync + Unpin + 'static,
    R: Fn() -> CopyObjectRequest + Clone + Unpin + Sync + Send + 'static,

Copy all listed objects, to a different S3 location as defined in mapping and dest_bucket. If other_bucket is not provided, copy to same bucket

pub fn move_all<F, R>(
    self,
    dest_bucket: Option<String>,
    mapping: F,
    default_request: R
) -> impl Future<Output = Result<(), Error>>where
    F: Fn(&str) -> String + Clone + Send + Sync + Unpin + 'static,
    R: Fn() -> CopyObjectRequest + Clone + Unpin + Sync + Send + 'static,

pub fn move_to_prefix<R>(
    self,
    dest_bucket: Option<String>,
    new_prefix: String,
    default_request: R
) -> impl Future<Output = Result<(), Error>>where
    R: Fn() -> CopyObjectRequest + Clone + Unpin + Sync + Send + 'static,

Move all listed objects by substituting their common prefix with new_prefix.

Trait Implementations

impl<C, S> Stream for ListObjects<C, S>where
    S: Stream<Item = Result<ListObjectsV2Output, Error>> + Sized + Send + Unpin,
    C: Unpin,

type Item = Result<ListObjectsV2Output, Error>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

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

Returns the bounds on the remaining length of the stream.