Struct Metadata 

pub struct Metadata {
    header: MetadataHeader,
    values: CompactValues,
}

Metadata contains all the information related to a specific path.

Metadata is tied to the operation that produced it. The same path can have different metadata across versions or requests.

File versions

In systems that support versioning, metadata can represent a specific object version. Metadata::version returns its version identifier when available. Metadata::is_current and Metadata::is_deleted describe whether that version is current or deleted.

is_current	is_deleted	Meaning
Some(true)	false	The current object version.
Some(true)	true	The current delete marker or soft-deleted version.
Some(false)	false	A previous accessible version.
Some(false)	true	A previous deleted version.
None	false	A non-deleted object whose current-version status is unknown.
None	true	A deleted object whose current-version status is unknown.

Metadata is an immutable owned value. Use [MetadataBuilder] to create a value and Metadata::into_builder to create a modified value.

Fields

header: MetadataHeader

values: CompactValues

Implementations

impl Metadata

pub fn into_builder(self) -> MetadataBuilder

Consume this metadata and return a builder initialized with its values.

pub fn mode(&self) -> EntryMode

Return this entry’s mode.

pub fn is_file(&self) -> bool

Return true if this metadata is for a file.

pub fn is_dir(&self) -> bool

Return true if this metadata is for a directory.

pub fn is_current(&self) -> Option<bool>

Return whether this metadata describes the current object version.

None means the service did not report whether the version is current.

pub fn is_deleted(&self) -> bool

Return whether this metadata describes a deleted object or delete marker.

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

Return this entry’s Cache-Control value.

See RFC 9111.

pub fn content_length(&self) -> u64

Return the full content length of this entry.

For file metadata returned by stat, list, or read operations, this value is the complete object size even when a read returns only a range. Directory and unknown metadata return zero.

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

Return this entry’s Content-MD5 value.

OpenDAL returns the service-provided value and does not guarantee that it is the MD5 digest of the content.

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

Return this entry’s Content-Type value.

See RFC 9110.

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

Return this entry’s Content-Encoding value.

See RFC 9110.

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

Return this entry’s Last-Modified timestamp.

See RFC 9110.

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

Return this entry’s service-provided ETag as-is.

Quotes and weak-validator prefixes are part of the returned value. See RFC 9110.

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

Return this entry’s Content-Disposition value.

See RFC 6266.

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

Return this entry’s service-specific version identifier.

pub fn user_metadata(&self) -> Option<UserMetadata<'_>>

Return a borrowed view of this entry’s user metadata.

Service-specific metadata prefixes are removed from the returned keys.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl PartialEq for Metadata

fn eq(&self, other: &Metadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Metadata