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.

Contains all metadata needed to locate and serve the file. The server stores this as a JSON string inside FILE-typed columns.

JSON example

{
  "id": "1234567890123456789",
  "sub": "f0001",
  "name": "document.pdf",
  "size": 1048576,
  "mime": "application/pdf",
  "sha256": "abc123..."
}

Fields

id: String

Unique file identifier (Snowflake ID).

sub: String

Subfolder name (e.g., "f0001", "f0002").

name: String

Original filename (preserved for display/download).

size: u64

File size in bytes.

mime: String

MIME type (e.g., "image/png", "application/pdf").

sha256: String

SHA-256 hash of file content (hex-encoded).

shard: Option<u32>

Optional shard ID for shared tables.

Implementations

impl FileRef

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

Parse a FileRef from a raw JSON string (as stored in FILE columns).

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

Try to extract a FileRef from a serde_json::Value.

Handles both:

• A JSON string (the value is parsed as JSON)
• A JSON object (deserialized directly)

pub fn to_json(&self) -> String

Serialize back to a JSON string.

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

Full download URL for this file.

{base_url}/v1/files/{namespace}/{table}/{sub}/{stored_name}

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

Relative HTTP path (no host) for this file.

/v1/files/{namespace}/{table}/{sub}/{stored_name}

pub fn stored_name(&self) -> String

Stored filename on disk.

Format: {id}-{sanitized_name}.{ext} or {id}.{ext} when the original name contains only non-ASCII characters.

pub fn relative_path(&self) -> String

Relative path within the table folder.

• User tables: {sub}/{stored_name}
• Shared tables with shard: shard-{n}/{sub}/{stored_name}

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.

Examples: "Image", "Video", "PDF Document", "PNG File".

pub fn format_size(&self) -> String

Format file size in human-readable units.

Examples: "0 B", "256 KB", "1.5 MB", "3.2 GB".

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