Struct FileIO

pub struct FileIO { /* private fields */ }

FileIO implementation, used to manipulate files in underlying storage.

Note

All path passed to FileIO must be absolute path starting with scheme string used to construct FileIO. For example, if you construct FileIO with s3a scheme, then all path passed to FileIO must start with s3a://.

Supported storages:

Storage	Feature Flag	Expected Path Format	Schemes
Local file system	storage-fs	file	file://path/to/file
Memory	storage-memory	memory	memory://path/to/file
S3	storage-s3	s3, s3a	s3://<bucket>/path/to/file
GCS	storage-gcs	gs, gcs	gs://<bucket>/path/to/file
OSS	storage-oss	oss	oss://<bucket>/path/to/file
Azure Datalake	storage-azdls	abfs, abfss, wasb, wasbs	abfs://<filesystem>@<account>.dfs.core.windows.net/path/to/file or wasb://<container>@<account>.blob.core.windows.net/path/to/file

Implementations

impl FileIO

pub fn into_builder(self) -> FileIOBuilder

Convert FileIO into FileIOBuilder which used to build this FileIO.

This function is useful when you want serialize and deserialize FileIO across distributed systems.

pub fn from_path(path: impl AsRef<str>) -> Result<FileIOBuilder>

Try to infer file io scheme from path. See FileIO for supported schemes.

• If it’s a valid url, for example s3://bucket/a, url scheme will be used, and the rest of the url will be ignored.
• If it’s not a valid url, will try to detect if it’s a file path.

Otherwise will return parsing error.

pub async fn delete(&self, path: impl AsRef<str>) -> Result<()>

Deletes file.

Arguments

• path: It should be absolute path starting with scheme string used to construct FileIO.

pub async fn remove_dir_all(&self, path: impl AsRef<str>) -> Result<()>

Remove the path and all nested dirs and files recursively.

Arguments

• path: It should be absolute path starting with scheme string used to construct FileIO.

Behavior

• If the path is a file or not exist, this function will be no-op.
• If the path is a empty directory, this function will remove the directory itself.
• If the path is a non-empty directory, this function will remove the directory and all nested files and directories.

pub async fn exists(&self, path: impl AsRef<str>) -> Result<bool>

Check file exists.

Arguments

• path: It should be absolute path starting with scheme string used to construct FileIO.

pub fn new_input(&self, path: impl AsRef<str>) -> Result<InputFile>

Creates input file.

Arguments

• path: It should be absolute path starting with scheme string used to construct FileIO.

pub fn new_output(&self, path: impl AsRef<str>) -> Result<OutputFile>

Creates output file.

Arguments

• path: It should be absolute path starting with scheme string used to construct FileIO.

Trait Implementations

impl Clone for FileIO

fn clone(&self) -> FileIO

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileIO

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

Formats the value using the given formatter.