Struct File

pub struct File { /* private fields */ }

Metadata of a file stored in B2.

Implementations

impl File

pub fn action(&self) -> FileAction

The action taken to result in this File.

pub fn bucket_id(&self) -> &str

The ID of the bucket containing the file.

pub fn content_length(&self) -> Option<u64>

The number of bytes stored in the file.

Only meaningful when the action is FileAction::Upload or FileAction::Copy; otherwise the value is None.

pub fn sha1_checksum(&self) -> Option<&String>

The SHA-1 checksum of the bytes in the file.

There is no checksum for large files or when the action is FileAction::Hide or FileAction::Folder.

pub fn md5_checksum(&self) -> Option<&String>

The MD5 checksum of the bytes in the file.

There is no checksum for large files or when the action is FileAction::Hide or FileAction::Folder.

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

When action is FileAction::Upload, FileAction::Start, or FileAction::Copy, the file’s MIME type.

pub fn file_id(&self) -> &str

The B2 ID of the file.

pub fn file_info(&self) -> &Value

User-specified and other file metadata.

pub fn file_name(&self) -> &str

The name of the file.

pub fn file_retention(&self) -> Option<&FileRetention>

The file’s retention policy.

pub fn has_legal_hold<E>(&self) -> Result<Option<bool>, Error<E>>

where E: Debug + Display,

See if there is a legal hold on this file.

Returns an error if the Authorization does not have Capability::ReadFileLegalHolds.

Returns None if a legal hold is not valid for the file type (e.g., the action is hide or folder).

pub fn encryption_settings(&self) -> Option<&ServerSideEncryption>

The encryption settings for the file.

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

The date and time at which the file was uploaded.

If the action is Folder, returns None.

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for File

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.