Struct FileMetadata 

#[non_exhaustive]
pub struct FileMetadata { /* private fields */ }

Stable and extensible metadata for one filesystem resource.

Examples

use qubit_fs::metadata::{FileKind, FileMetadata};

let metadata = FileMetadata::new(FileKind::File).with_len(Some(42));
assert_eq!(Some(42), metadata.len());

Implementations

impl FileMetadata

pub fn new(kind: FileKind) -> Self

Creates metadata with only a file kind.

Parameters

• kind: Provider-neutral resource kind.

Returns

Metadata value with unknown optional fields.

pub const fn kind(&self) -> &FileKind

Returns the provider-neutral resource kind.

pub const fn len(&self) -> Option<u64>

Returns the known byte length, if any.

pub const fn is_empty(&self) -> bool

Returns whether the known byte length is zero.

pub const fn modified_at(&self) -> Option<SystemTime>

Returns the last modification time, if known.

pub const fn created_at(&self) -> Option<SystemTime>

Returns the creation time, if known.

pub const fn accessed_at(&self) -> Option<SystemTime>

Returns the last access time, if known.

pub const fn etag(&self) -> Option<&ResourceVersion>

Returns the provider version or ETag, if known.

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

Returns the content type, if known.

Returns

Some with the content type borrowed from this snapshot, or None when the provider did not report one.

pub const fn checksum(&self) -> Option<&Checksum>

Returns the content checksum, if known.

pub const fn user_metadata(&self) -> &NonSensitiveMetadata

Returns validated user-defined metadata.

pub const fn provider_metadata(&self) -> &NonSensitiveMetadata

Returns validated provider-native metadata.

pub fn with_kind(self, kind: FileKind) -> Self

Replaces the resource kind.

pub fn with_len(self, len: Option<u64>) -> Self

Replaces the known byte length.

pub fn with_modified_at(self, value: Option<SystemTime>) -> Self

Replaces the last modification time.

pub fn with_created_at(self, value: Option<SystemTime>) -> Self

Replaces the creation time.

pub fn with_accessed_at(self, value: Option<SystemTime>) -> Self

Replaces the last access time.

pub fn with_etag(self, value: Option<ResourceVersion>) -> Self

Replaces the provider version or ETag.

pub fn with_content_type(self, value: Option<String>) -> Self

Replaces the content type.

pub fn with_checksum(self, value: Option<Checksum>) -> Self

Replaces the content checksum.

pub fn with_user_metadata(self, metadata: UserMetadata) -> Self

Replaces user-defined metadata that has already passed key validation.

pub fn with_provider_metadata(self, metadata: UserMetadata) -> Self

Replaces provider-native metadata that has already passed key validation.

pub fn is_directory_like(&self) -> bool

Tells whether this metadata describes a directory-like resource.

Returns

true for directories and prefixes.

pub fn is_file_like(&self) -> bool

Tells whether this metadata describes a file-like resource.

Returns

true for regular files and object-store objects.

Trait Implementations

impl Clone for FileMetadata

fn clone(&self) -> FileMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileMetadata

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

Formats the value using the given formatter.

impl PartialEq for FileMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FileMetadata