Struct opendal::Entry

pub struct Entry { /* private fields */ }

Entry returned by Lister or BlockingLister to represent a path and it’s relative metadata.

Notes

Entry returned by Lister or BlockingLister may carry some already known metadata. Lister by default only make sure that Mode is fetched. To make sure the entry contains metadata you want, please use list_with or lister_with and metakey.

For example:

use opendal::EntryMode;
use opendal::Metakey;
use opendal::Operator;
let mut entries = op
    .list_with("dir/")
    .metakey(Metakey::ContentLength | Metakey::LastModified)
    .await?;
for entry in entries {
    let meta = entry.metadata();
    match meta.mode() {
        EntryMode::FILE => {
            println!(
                "Handling file {} with size {}",
                entry.path(),
                meta.content_length()
            )
        }
        EntryMode::DIR => {
            println!("Handling dir {}", entry.path())
        }
        EntryMode::Unknown => continue,
    }
}

Implementations

impl Entry

pub fn path(&self) -> &str

Path of entry. Path is relative to operator’s root.

Only valid in current operator.

If this entry is a dir, path MUST end with / Otherwise, path MUST NOT end with /.

pub fn name(&self) -> &str

Name of entry. Name is the last segment of path.

If this entry is a dir, name MUST end with / Otherwise, name MUST NOT end with /.

pub fn metadata(&self) -> &Metadata

Fetch metadata of this entry.

Notes

Metadata only guaranteed to have results of metakey (which default to Metakey::Mode).

• Some(T) means the metadata is valid.
• None means the metadata is not provided by services.

Visiting a metadata that not covered by metakey could result in panic.

Examples

Please use metakey to specify the metadata you want, for example:

use opendal::EntryMode;
use opendal::Metakey;
use opendal::Operator;
let mut entries = op
    .list_with("dir/")
    .metakey(Metakey::ContentLength | Metakey::LastModified)
    .await?;
for entry in entries {
    let meta = entry.metadata();
    match meta.mode() {
        EntryMode::FILE => {
            println!(
                "Handling file {} with size {}",
                entry.path(),
                meta.content_length()
            )
        }
        EntryMode::DIR => {
            println!("Handling dir {}", entry.path())
        }
        EntryMode::Unknown => continue,
    }
}

pub fn into_parts(self) -> (String, Metadata)

Consume this entry to get it’s path and metadata.

Notes

Metadata only guaranteed to have results of metakey (which default to Metakey::Mode).

• Some(T) means the metadata is valid.
• None means the metadata is not provided by services.

Visiting a metadata that not covered by metakey could result in panic.

Examples

Please use metakey to specify the metadata you want, for example:

use opendal::EntryMode;
use opendal::Metakey;
use opendal::Operator;
let mut entries = op
    .list_with("dir/")
    .metakey(Metakey::ContentLength | Metakey::LastModified)
    .await?;
for entry in entries {
    let (path, meta) = entry.into_parts();
    match meta.mode() {
        EntryMode::FILE => {
            println!("Handling file {} with size {}", path, meta.content_length())
        }
        EntryMode::DIR => {
            println!("Handling dir {}", path)
        }
        EntryMode::Unknown => continue,
    }
}

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Entry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entry

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

Formats the value using the given formatter.