Struct opendal::ObjectMetadata

pub struct ObjectMetadata { /* private fields */ }

Metadata carries all object metadata.

Notes

mode and content_length are required metadata that all services should provide during stat operation. But in list operation, a.k.a., ObjectEntry’s content length could be None.

Implementations

impl ObjectMetadata

pub fn new(mode: ObjectMode) -> Self

Create a new object metadata

pub fn is_complete(&self) -> bool

If this object metadata if complete

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

Make this object metadata if complete.

pub fn with_complete(self) -> Self

Make this object metadata if complete.

pub fn mode(&self) -> ObjectMode

Object mode represent this object’s mode.

pub fn set_mode(&mut self, mode: ObjectMode) -> &mut Self

Set mode for object.

pub fn with_mode(self, mode: ObjectMode) -> Self

Set mode for object.

pub fn content_length(&self) -> u64

Content length of this object.

Content-Length is defined by RFC 7230 Refer to MDN Content-Length for more information.

pub fn set_content_length(&mut self, content_length: u64) -> &mut Self

Set content length of this object.

pub fn with_content_length(self, content_length: u64) -> Self

Set content length of this object.

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

Content MD5 of this object.

Content MD5 is defined by RFC 2616. And removed by RFC 7231.

OpenDAL will try its best to set this value, but not guarantee this value is the md5 of content.

pub fn set_content_md5(&mut self, content_md5: &str) -> &mut Self

Set content MD5 of this object.

Content MD5 is defined by RFC 2616. And removed by RFC 7231.

pub fn with_content_md5(self, content_md5: &str) -> Self

Set content MD5 of this object.

Content MD5 is defined by RFC 2616. And removed by RFC 7231.

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

Content Type of this object.

Content Type is defined by RFC 9110.

pub fn set_content_type(&mut self, v: &str) -> &mut Self

Set Content Type of this object.

Content Type is defined by RFC 9110.

pub fn with_content_type(self, v: &str) -> Self

Set Content Type of this object.

Content Type is defined by RFC 9110.

pub fn content_range(&self) -> Option<BytesContentRange>

Content Range of this object.

Content Range is defined by RFC 9110.

pub fn set_content_range(&mut self, v: BytesContentRange) -> &mut Self

Set Content Range of this object.

Content Range is defined by RFC 9110.

pub fn with_content_range(self, v: BytesContentRange) -> Self

Set Content Range of this object.

Content Range is defined by RFC 9110.

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

Last modified of this object.

Last-Modified is defined by RFC 7232 Refer to MDN Last-Modified for more information.

OpenDAL parse the raw value into OffsetDateTime for convenient.

pub fn set_last_modified(&mut self, last_modified: OffsetDateTime) -> &mut Self

Set Last modified of this object.

Last-Modified is defined by RFC 7232 Refer to MDN Last-Modified for more information.

pub fn with_last_modified(self, last_modified: OffsetDateTime) -> Self

Set Last modified of this object.

Last-Modified is defined by RFC 7232 Refer to MDN Last-Modified for more information.

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

ETag of this object.

ETag is defined by RFC 7232 Refer to MDN ETag for more information.

OpenDAL will return this value AS-IS like the following:

• "33a64df551425fcc55e4d42a148795d9f25f89d4"
• W/"0815"

" is part of etag.

pub fn set_etag(&mut self, etag: &str) -> &mut Self

Set ETag of this object.

ETag is defined by RFC 7232 Refer to MDN ETag for more information.

OpenDAL will return this value AS-IS like the following:

• "33a64df551425fcc55e4d42a148795d9f25f89d4"
• W/"0815"

" is part of etag, don’t trim it before setting.

pub fn with_etag(self, etag: &str) -> Self

Set ETag of this object.

ETag is defined by RFC 7232 Refer to MDN ETag for more information.

OpenDAL will return this value AS-IS like the following:

• "33a64df551425fcc55e4d42a148795d9f25f89d4"
• W/"0815"

" is part of etag, don’t trim it before setting.

Trait Implementations

impl Clone for ObjectMetadata

fn clone(&self) -> ObjectMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ObjectMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<ObjectMetadata> for ObjectMetadata

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ObjectMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ObjectMetadata

impl StructuralEq for ObjectMetadata

impl StructuralPartialEq for ObjectMetadata