Struct FileRef 

pub struct FileRef {
    pub id: String,
    pub sub: String,
    pub name: String,
    pub size: u64,
    pub mime: String,
    pub sha256: String,
    pub shard: Option<u32>,
}

File reference stored as JSON in FILE columns.

Fields

id: String

Unique file identifier.

sub: String

Subfolder name, for example "f0001".

name: String

Original filename preserved for display and download.

size: u64

File size in bytes.

mime: String

MIME type.

sha256: String

SHA-256 hash of file content, hex encoded.

shard: Option<u32>

Optional shard ID for shared tables.

Implementations

impl FileRef

pub fn new( id: String, subfolder: String, name: String, size: u64, mime: String, sha256: String, ) -> FileRef

Create a new file reference.

pub fn with_shard( id: String, subfolder: String, name: String, size: u64, mime: String, sha256: String, shard: u32, ) -> FileRef

Create a new file reference with shared-table shard metadata.

pub fn partial(id: String, subfolder: String) -> FileRef

Create a partial file reference for download path validation.

pub fn from_json(json: &str) -> Option<FileRef>

Parse a file reference from a raw JSON string.

pub fn try_from_json(json: &str) -> Result<FileRef, Error>

Parse a file reference from a raw JSON string, preserving serde errors.

pub fn from_json_value(value: &Value) -> Option<FileRef>

Try to extract a file reference from a JSON value.

pub fn to_json(&self) -> String

Serialize to JSON for storage in FILE columns.

pub fn download_url( &self, base_url: &str, namespace: &str, table: &str, ) -> String

Full download URL for this file.

pub fn relative_url(&self, namespace: &str, table: &str) -> String

Relative HTTP path for this file.

pub fn stored_name(&self) -> String

Stored filename on disk.

pub fn is_valid_subfolder(subfolder: &str) -> bool

Validate subfolder name format, for example "f0001".

pub fn relative_path(&self) -> String

Relative path within the table folder.

pub fn is_image(&self) -> bool

Returns true if the MIME type indicates an image.

pub fn is_video(&self) -> bool

Returns true if the MIME type indicates a video.

pub fn is_audio(&self) -> bool

Returns true if the MIME type indicates audio.

pub fn is_pdf(&self) -> bool

Returns true if the MIME type indicates a PDF.

pub fn type_description(&self) -> String

Human-readable file type description.

pub fn format_size(&self) -> String

Format file size in human-readable units.

pub fn validate_mime_type(&self, allowed_mimes: &[String]) -> bool

Validate MIME type against an allowlist.

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<FileRef, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FileRef

impl From<&FileRef> for QueryParam

fn from(value: &FileRef) -> QueryParam

Converts to this type from the input type.

impl From<FileRef> for QueryParam

fn from(value: FileRef) -> QueryParam

Converts to this type from the input type.

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileRef