Struct datafusion_objectstore_s3::object_store::s3::S3FileSystem

pub struct S3FileSystem { /* private fields */ }

ObjectStore implementation for the Amazon S3 API

Implementations

impl S3FileSystem

pub async fn new(
    credentials_provider: Option<SharedCredentialsProvider>,
    region: Option<Region>,
    endpoint: Option<Endpoint>,
    retry_config: Option<RetryConfig>,
    sleep: Option<Arc<dyn AsyncSleep>>,
    timeout_config: Option<Config>
) -> Self

Create new ObjectStore

impl S3FileSystem

pub async fn default() -> Self

Convenience wrapper for creating a new S3FileSystem using default configuration options. Only works with AWS.

Trait Implementations

impl Debug for S3FileSystem

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

Formats the value using the given formatter.

impl ObjectStore for S3FileSystem

fn list_file<'life0, 'life1, 'async_trait>(
    &'life0 self,
    prefix: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<FileMetaStream>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Returns all the files in path prefix

fn list_dir<'life0, 'life1, 'async_trait>(
    &'life0 self,
    _prefix: &'life1 str,
    _delimiter: Option<String>
) -> Pin<Box<dyn Future<Output = Result<ListEntryStream>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Returns all the files in prefix if the prefix is already a leaf dir, or all paths between the prefix and the first occurrence of the delimiter if it is provided.

fn file_reader(&self, file: SizedFile) -> Result<Arc<dyn ObjectReader>>

Get object reader for one file

fn list_file_with_suffix<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    prefix: &'life1 str,
    suffix: &'life2 str
) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<FileMeta, Error>> + Sync + Send + 'static, Global>>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Calls list_file with a suffix filter

fn glob_file<'life0, 'life1, 'async_trait>(
    &'life0 self,
    glob_pattern: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<FileMeta, Error>> + Sync + Send + 'static, Global>>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Returns all the files matching glob_pattern

fn glob_file_with_suffix<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    glob_pattern: &'life1 str,
    suffix: &'life2 str
) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<FileMeta, Error>> + Sync + Send + 'static, Global>>, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Calls glob_file with a suffix filter