Struct FileRef 

pub struct FileRef {
    pub blob_hash: String,
    pub encryption_info: ConvergentEncryptionInfo,
    pub filename: Option<String>,
    pub content_type: Option<String>,
    pub metadata: Vec<Metadata>,
}

Reference to a stored file, containing everything needed to retrieve it

This type represents metadata for files that have been encrypted using convergent encryption and stored in a content-addressable blob store. It contains all the information needed to retrieve and decrypt the file later.

Fields

blob_hash: String

Hash of the encrypted blob in storage

This is the content-addressable hash used by the blob storage system to uniquely identify and retrieve the encrypted file data.

encryption_info: ConvergentEncryptionInfo

Encryption metadata needed for decryption

Contains the encryption key, compression settings, and other metadata required to decrypt the stored file back to its original form.

filename: Option<String>

Original filename (for reference)

The name of the file when it was stored. This is kept for reference and display purposes and doesn’t affect retrieval. This is optional to support cases where filename is not relevant.

content_type: Option<String>

MIME type or file extension for reference

Optional content type information derived from the file extension or explicitly provided when storing the file.

metadata: Vec<Metadata>

Additional metadata about the stored file

Structured metadata that applications can use to store additional information about the file (e.g., original timestamps, user tags, categories, etc.) using typed metadata variants.

Implementations

impl FileRef

pub fn new( blob_hash: String, encryption_info: ConvergentEncryptionInfo, filename: Option<String>, ) -> Self

Create a new FileRef with minimal required fields

pub fn with_metadata(self, key: String, value: String) -> Self

Add generic metadata to the stored file info

pub fn with_structured_metadata(self, metadata: Metadata) -> Self

Add structured metadata to the stored file info

pub fn generic_metadata(&self) -> BTreeMap<String, String>

Get all generic metadata as a key-value map for backward compatibility

This method extracts only the Metadata::Generic(key, value) entries and returns them as a BTreeMap<String, String> for backward compatibility with APIs that expect key-value metadata.

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

Set the content type

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

Get the filename (if available)

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

Get file extension from the filename (if available)

pub fn original_size(&self) -> usize

Get the original file size (from encryption info)

Trait Implementations

impl Clone for FileRef

fn clone(&self) -> FileRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FileRef

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for FileRef

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 FileRef

impl StructuralPartialEq for FileRef