exfile

v0.3.6

exfile v0.3.6 Exfile.Ecto.File View Source

An Ecto.Type used to handle files persisted to the store backend.

Link to this section Summary

Functions

cast(file)

Casts a recognizable value to an %Exfile.File{} and uploads it to the cache backend

dump(file)

Dumps an %Exfile.File{} struct to the file URI, suitable for storage in the database

load(file_uri)

Loads a file URI from the database and returns an %Exfile.File{} struct representing that file

type()

The Ecto type

upload!(file)

Uploads a file from the cache backend to the store backend

Link to this section Functions

Link to this function cast(file) View Source

Casts a recognizable value to an %Exfile.File{} and uploads it to the cache backend.

Accepts five patterns:

  • An %Exfile.File{} stored in the cache or store backends
  • An %Exfile.File{} stored in a different backend
  • An %Exfile.LocalFile{}
  • A %Plug.Upload{}
  • A string URI representing a file from an arbitrary backend

The string URI can be used to upload a file that is currently stored in a separate backend. The format is:

exfile://[backend name]/[file ID]
Link to this function dump(file) View Source

Dumps an %Exfile.File{} struct to the file URI, suitable for storage in the database.

Link to this function load(file_uri) View Source

Loads a file URI from the database and returns an %Exfile.File{} struct representing that file.

Supports loading a plain ID for backwards compatibility.

Link to this function upload!(file) View Source

Uploads a file from the cache backend to the store backend.

This function should be called after the record has been successfully saved to the database and all validations are passing.