Struct FileIO 

pub struct FileIO { /* private fields */ }

Implementations

impl FileIO

pub fn from_url(path: &str) -> Result<FileIOBuilder>

Try to infer file io scheme from path.

The input HashMap is paimon-java’s Options

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 fn new_input(&self, path: &str) -> Result<InputFile>

Create a new input file to read data.

Reference: https://github.com/apache/paimon/blob/release-0.8.2/paimon-common/src/main/java/org/apache/paimon/fs/FileIO.java#L76

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

Create a new output file to write data.

Reference: https://github.com/apache/paimon/blob/release-0.8.2/paimon-common/src/main/java/org/apache/paimon/fs/FileIO.java#L87

pub async fn get_status(&self, path: &str) -> Result<FileStatus>

Return a file status object that represents the path.

Reference: https://github.com/apache/paimon/blob/release-0.8.2/paimon-common/src/main/java/org/apache/paimon/fs/FileIO.java#L97

pub async fn list_status(&self, path: &str) -> Result<Vec<FileStatus>>

List the statuses of the files/directories in the given path if the path is a directory.

References: https://github.com/apache/paimon/blob/release-0.8.2/paimon-common/src/main/java/org/apache/paimon/fs/FileIO.java#L105

FIXME: how to handle large dir? Better to return a stream instead?

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

Check if exists.

References: https://github.com/apache/paimon/blob/release-0.8.2/paimon-common/src/main/java/org/apache/paimon/fs/FileIO.java#L128

pub async fn delete_file(&self, path: &str) -> Result<()>

Delete a file.

Reference: https://github.com/apache/paimon/blob/release-0.8.2/paimon-common/src/main/java/org/apache/paimon/fs/FileIO.java#L139

pub async fn delete_dir(&self, path: &str) -> Result<()>

Delete a dir recursively.

Reference: https://github.com/apache/paimon/blob/release-0.8.2/paimon-common/src/main/java/org/apache/paimon/fs/FileIO.java#L139

pub async fn mkdirs(&self, path: &str) -> Result<()>

Make the given file and all non-existent parents into directories.

Has the semantics of Unix ‘mkdir -p’. Existence of the directory hierarchy is not an error.

Reference: https://github.com/apache/paimon/blob/release-0.8.2/paimon-common/src/main/java/org/apache/paimon/fs/FileIO.java#L150

pub async fn rename(&self, src: &str, dst: &str) -> Result<()>

Renames the file/directory src to dst.

Reference: https://github.com/apache/paimon/blob/release-0.8.2/paimon-common/src/main/java/org/apache/paimon/fs/FileIO.java#L159

Trait Implementations

impl Clone for FileIO

fn clone(&self) -> FileIO

Returns a duplicate 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.