Struct FileField 

pub struct FileField(/* private fields */);

A TEXT-backed handle to a file in the ambient Storage backend.

The inner String is the storage key. Construct one from a key with FileField::from (String or &str), read the key with FileField::key, and resolve the public URL with FileField::url. See the module docs for the serialisation + storage-resolution contract.

Implementations

impl FileField

pub fn key(&self) -> &str

Borrow the storage key — the value persisted in the column.

pub fn url(&self) -> String

Resolve the public URL for this file through the ambient storage backend.

When a backend is registered (the production posture — the boot system check enforces it for any model with a file/image field), this returns storage.url(key). When none is registered, it falls back to the raw key so a template render never panics. See the module docs.

pub fn is_empty(&self) -> bool

true when no file is attached (the key is empty). The default FileField is empty.

Trait Implementations

impl AsRef<str> for FileField

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for FileField

fn clone(&self) -> FileField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileField

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

Formats the value using the given formatter.

impl<'r> Decode<'r, Postgres> for FileField

fn decode(value: PgValueRef<'r>) -> Result<Self, Box<dyn Error + Send + Sync>>

Decode a new value of this type using a raw value from the database.

impl<'r> Decode<'r, Sqlite> for FileField

fn decode( value: SqliteValueRef<'r>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

Decode a new value of this type using a raw value from the database.

impl Default for FileField

fn default() -> FileField

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileField

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Read a JSON string straight into the key.

impl Display for FileField

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

Renders the storage key (not the resolved URL) — matches the serialised form and what a bare String column would print. Use FileField::url when you need the public URL.

impl<'q> Encode<'q, Postgres> for FileField

fn encode_by_ref( &self, buf: &mut <Postgres as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Send + Sync>>

Writes the value of self into buf without moving self.

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

impl<'q> Encode<'q, Sqlite> for FileField

fn encode_by_ref( &self, buf: &mut <Sqlite as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Send + Sync>>

Writes the value of self into buf without moving self.

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

impl Eq for FileField

impl From<&str> for FileField

fn from(key: &str) -> Self

Converts to this type from the input type.

impl From<String> for FileField

fn from(key: String) -> Self

Converts to this type from the input type.

impl PartialEq for FileField

fn eq(&self, other: &FileField) -> 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 FileField

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialise as the bare key string so REST / JSON round-trip the key transparently (same shape as a String column).

impl StructuralPartialEq for FileField

impl Type<Postgres> for FileField

fn type_info() -> PgTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &PgTypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl Type<Sqlite> for FileField

fn type_info() -> SqliteTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &SqliteTypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.