Struct opendal::DirEntry

pub struct DirEntry { /* private fields */ }

ObjectEntry is returned by ObjectStream during object list.

Users can check returning object entry’s mode or convert into an object without overhead.

Implementations

impl ObjectEntry

pub fn new(
    acc: Arc<dyn Accessor>,
    path: &str,
    meta: ObjectMetadata
) -> ObjectEntry

Create a new object entry by its corresponding underlying storage.

pub fn set_accessor(&mut self, acc: Arc<dyn Accessor>)

Set accessor for this entry.

pub fn set_complete(&mut self) -> &mut Self

Complete means this object entry already carries all metadata that it could have. Don’t call metadata anymore.

pub fn with_complete(self) -> Self

Complete means this object entry already carries all metadata that it could have. Don’t call metadata anymore.

pub fn into_object(self) -> Object

Convert ObjectEntry 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 object entry’s object mode.

pub fn id(&self) -> String

Return this object entry’s id.

The same with Object::id()

pub fn path(&self) -> &str

Return this object entry’s path.

The same with Object::path()

pub fn set_path(&mut self, path: &str)

Set path for this entry.

pub fn name(&self) -> &str

Return this object entry’s name.

The same with Object::name()

pub async fn metadata(&self) -> ObjectMetadata

Fetch metadata about this object entry.

pub fn blocking_metadata(&self) -> ObjectMetadata

Fetch metadata about this object entry.

The same with Object::blocking_metadata()

pub fn set_metadata(&self, meta: ObjectMetadata) -> &Self

Update ObjectEntry’s metadata by setting new one.

pub async fn content_length(&self) -> u64

The size of ObjectEntry’s corresponding object

content_length is a prefetched metadata field in ObjectEntry.

pub async fn content_md5(&self) -> Option<String>

The MD5 message digest of ObjectEntry’s corresponding object

content_md5 is a prefetched metadata field in ObjectEntry

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

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

The last modified UTC datetime of ObjectEntry’s corresponding object

last_modified is a prefetched metadata field in ObjectEntry

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

pub async fn etag(&self) -> Option<String>

The ETag string of ObjectEntry’s corresponding object

etag is a prefetched metadata field in ObjectEntry.

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

Trait Implementations

impl Clone for ObjectEntry

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectEntry

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

Formats the value using the given formatter.

impl From<ObjectEntry> for Object

ObjectEntry can convert into object without overhead.

fn from(d: ObjectEntry) -> Self

Converts to this type from the input type.