Struct opendal :: Metadata Copy item path

impl Metadata

pub fn new(mode: EntryMode) -> Self

Create a new metadata

pub fn mode(&self) -> EntryMode

mode represent this entry’s mode.

pub fn is_file(&self) -> bool

Returns true if this metadata is for a file.

pub fn is_dir(&self) -> bool

Returns true if this metadata is for a directory.

pub fn set_mode(&mut self, v: EntryMode) -> &mut Self

Set mode for entry.

pub fn with_mode(self, v: EntryMode) -> Self

Set mode for entry.

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

Cache control of this entry. Cache-Control is defined by RFC 7234 Refer to MDN Cache-Control for more information.

This value is only available when calling on result of stat or list with [Metakey::CacheControl], otherwise this method returns None.

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

Set cache control of this entry.

Cache-Control is defined by RFC 7234 Refer to MDN Cache-Control for more information.

pub fn with_cache_control(self, v: String) -> Self

Set cache control of this entry.

Cache-Control is defined by RFC 7234 Refer to MDN Cache-Control for more information.

pub fn content_length(&self) -> u64

Content length of this entry.

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

§Panics

This value is only available when calling on result of stat or list with [Metakey::ContentLength], otherwise it will panic.

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

Set content length of this entry.

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

Set content length of this entry.

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

Content MD5 of this entry.

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.

This value is only available when calling on result of stat or list with [Metakey::ContentMd5], otherwise this method returns None.

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

Set content MD5 of this entry.

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

pub fn with_content_md5(self, v: String) -> Self

Set content MD5 of this entry.

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

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

Content Type of this entry.

Content Type is defined by RFC 9110.

This value is only available when calling on result of stat or list with [Metakey::ContentType], otherwise this method returns None.

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

Set Content Type of this entry.

Content Type is defined by RFC 9110.

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

Set Content Type of this entry.

Content Type is defined by RFC 9110.

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

Content Encoding of this entry.

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

Set Content Encoding of this entry.

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

Content Range of this entry.

Content Range is defined by RFC 9110.

This value is only available when calling on result of stat or list with [Metakey::ContentRange], otherwise this method returns None.

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

Set Content Range of this entry.

Content Range is defined by RFC 9110.

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

Set Content Range of this entry.

Content Range is defined by RFC 9110.

pub fn last_modified(&self) -> Option<DateTime<Utc>>

Last modified of this entry.

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

OpenDAL parse the raw value into DateTime for convenient.

This value is only available when calling on result of stat or list with [Metakey::LastModified], otherwise this method returns None.

pub fn set_last_modified(&mut self, v: DateTime<Utc>) -> &mut Self

Set Last modified of this entry.

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

pub fn with_last_modified(self, v: DateTime<Utc>) -> Self

Set Last modified of this entry.

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

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

ETag of this entry.

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.

This value is only available when calling on result of stat or list with [Metakey::Etag], otherwise this method returns None.

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

Set ETag of this entry.

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, v: String) -> Self

Set ETag of this entry.

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 content_disposition(&self) -> Option<&str>

Content-Disposition of this entry

Content-Disposition is defined by RFC 2616 and clarified usage in RFC 6266. Refer to MDN Content-Disposition for more information.

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

“inline”
“attachment”
“attachment; filename="filename.jpg"”

This value is only available when calling on result of stat or list with [Metakey::ContentDisposition], otherwise this method returns None.

pub fn with_content_disposition(self, v: String) -> Self

Set Content-Disposition of this entry

Content-Disposition is defined by RFC 2616 and clarified usage in RFC 6266. Refer to MDN Content-Disposition for more information.

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

“inline”
“attachment”
“attachment; filename="filename.jpg"”

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

Set Content-Disposition of this entry

Content-Disposition is defined by RFC 2616 and clarified usage in RFC 6266. Refer to MDN Content-Disposition for more information.

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

“inline”
“attachment”
“attachment; filename="filename.jpg"”

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

Version of this entry.

Version is a string that can be used to identify the version of this entry.

This field may come out from the version control system, like object versioning in AWS S3.

This value is only available when calling on result of stat or list with [Metakey::Version], otherwise this method returns None.

pub fn with_version(self, v: String) -> Self

Set version of this entry.

Version is a string that can be used to identify the version of this entry.

This field may come out from the version control system, like object versioning in AWS S3.

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

Set version of this entry.

Version is a string that can be used to identify the version of this entry.

This field may come out from the version control system, like object versioning in AWS S3.

pub fn user_metadata(&self) -> Option<&HashMap<String, String>>

User defined metadata of this entry

The prefix of the user defined metadata key(for example: in oss, it’s x-oss-meta-) is remove from the key

pub fn with_user_metadata(&mut self, data: HashMap<String, String>) -> &mut Self

Set user defined metadata of this entry

Trait Implementations§

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Metadata

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

Formats the value using the given formatter. Read more

impl From<MetaData> for Metadata

Available on crate feature services-sftp only.

REMOVE ME: we should not implement From<SftpMeta> for Metadata.

fn from(meta: SftpMeta) -> Self

Converts to this type from the input type.

impl PartialEq for Metadata

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

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

1.0.0 · source§

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 Eq for Metadata

impl StructuralPartialEq for Metadata

Auto Trait Implementations§

impl UnwindSafe for Metadata

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more