Struct opendal::Metadata

impl Metadata

pub fn new(mode: EntryMode) -> Self

Create a new metadata

pub fn metakey(&self) -> FlagSet<Metakey>

Get the metakey from metadata.

This value describes which metadata has been set.

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.

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.

Panics

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

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.

Panics

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

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_range(&self) -> Option<BytesContentRange>

Content Range of this entry.

Content Range is defined by RFC 9110.

Panics

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

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.

Panics

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

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.

Panics

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

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"”

Panics

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

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.

Panics

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

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.

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 StructuralEq 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> Conv for T

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

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

impl<Choices> CoproductSubsetter<CNil, HNil> for Choices

type Remainder = Choices

fn subset( self ) -> Result<CNil, <Choices as CoproductSubsetter<CNil, HNil>>::Remainder>

Extract a subset of the possible types in a coproduct (or get the remaining possibilities) 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<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<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> 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> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T, U, I> LiftInto<U, I> for T
where U: LiftFrom<T, I>,

fn lift_into(self) -> U

Performs the indexed conversion.

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<Source> Sculptor<HNil, HNil> for Source

type Remainder = Source

fn sculpt(self) -> (HNil, <Source as Sculptor<HNil, HNil>>::Remainder)

Consumes the current HList and returns an HList with the requested shape. Read more

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

fn is_within(&self, b: &G2) -> bool

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

fn is_within(&self, b: &G2) -> bool