Struct opendal::DirEntry

pub struct DirEntry { /* private fields */ }

DirEntry is returned by DirStream during object list.

DirEntry carries two information: path and mode. Users can check returning dir entry’s mode or convert into an object without overhead.

Implementations

impl DirEntry

pub fn into_object(self) -> Object

Convert DirEntry into Object.

This function is the same with already implemented From trait. This function will make our users happier to avoid writing generic type parameter

pub fn mode(&self) -> ObjectMode

Return this dir entry’s object mode.

pub fn id(&self) -> String

Return this dir entry’s id.

The same with Object::id()

pub fn path(&self) -> &str

Return this dir entry’s path.

The same with Object::path()

pub fn name(&self) -> &str

Return this dir entry’s name.

The same with Object::name()

pub fn etag(&self) -> Option<&str>

The ETag string of DirEntry’s corresponding object

etag is a prefetched metadata field in DirEntry.

It doesn’t mean this metadata field of object doesn’t exist if etag is None. Then you have to call DirEntry::metadata() to get the metadata you want.

pub fn content_length(&self) -> Option<u64>

The size of DirEntry’s corresponding object

content_length is a prefetched metadata field in DirEntry.

It doesn’t mean this metadata field of object doesn’t exist if content_length is None. Then you have to call DirEntry::metadata() to get the metadata you want.

pub fn content_md5(&self) -> Option<&str>

The MD5 message digest of DirEntry’s corresponding object

content_md5 is a prefetched metadata field in DirEntry

It doesn’t mean this metadata field of object doesn’t exist if content_md5 is None. Then you have to call DirEntry::metadata() to get the metadata you want.

pub fn last_modified(&self) -> Option<OffsetDateTime>

The last modified UTC datetime of DirEntry’s corresponding object

last_modified is a prefetched metadata field in DirEntry

It doesn’t mean this metadata field of object doesn’t exist if last_modified is None. Then you have to call DirEntry::metadata() to get the metadata you want.

pub async fn metadata(&self) -> Result<ObjectMetadata>

Fetch metadata about this dir entry.

The same with Object::metadata()

Trait Implementations

impl Clone for DirEntry

fn clone(&self) -> DirEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DirEntry

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

Formats the value using the given formatter.

impl From<DirEntry> for Object

DirEntry can convert into object without overhead.

fn from(d: DirEntry) -> Self

Converts to this type from the input type.