View Source Trunk.Storage behaviour (trunk v1.4.0)

This is a behaviour that can be implemented by any storage module to make sure it supports all required functions.

Summary

opts()

Generates a URL to the S3 object

Deletes the version file from the storage system at path Path.join(directory, filename)

Save the source_file to the storage system on path Path.join(directory, filename)

@type opts() :: Keyword.t()

@callback build_uri(directory :: String.t(), filename :: String.t(), opts()) :: String.t()

Generates a URL to the S3 object

directory - The directory
filename - The name of the file
opts - The options for the storage system, set in Trunk option :storage_opts

MyStorage.build_url("path/to", "file.ext", some: :opt)
#=> "https://my-storage/my-bucket/path/to/file.ext"

@callback delete(directory :: String.t(), filename :: String.t(), opts()) ::
  :ok | {:error, any()}

Deletes the version file from the storage system at path Path.join(directory, filename)

directory - The directory
filename - The name of the file
opts - The options for the storage system, set in Trunk option :storage_opts

The file should be removed from <storage system>/my-bucket/path/to/file.ext

MyStorage.delete("path/to/", "file.ext", some: :opt)

@callback retrieve(
  directory :: String.t(),
  filename :: String.t(),
  destination_path :: String.t(),
  opts()
) :: :ok | {:error, any()}

@callback save(
  directory :: String.t(),
  filename :: String.t(),
  source_path :: String.t(),
  opts()
) ::
  :ok | {:error, any()}

Save the source_file to the storage system on path Path.join(directory, filename)

directory - The directory
filename - The name of the file
source_path - The full path to the file to be stored. This is a path to the uploaded file or a temporary file that has undergone transformation
opts - The options for the storage system, set in Trunk option :storage_opts

The file should be saved to <storage system>/my-bucket/path/to/file.ext

MyStorage.save("path/to/", "file.ext", "/tmp/uploaded_file.ext", some: :opt)