Belt

v0.5.1

Belt v0.5.1 Belt.Provider.Filesystem View Source

Provider module offering support for storing files in a directory on the local filesystem.

Link to this section Summary

Types

filesystem_option()

Options for creating an Filesystem provider

Functions

child_spec(opts)
default(options \\ [])

Creates a new Filesystem provider configuration with default credentials

delete(config, identifier, options)

Implementation of the Belt.Provider.delete/3 callback

delete_all(config, options)

Implementation of the Belt.Provider.delete_all/2 callback

delete_scope(config, scope, options)

Implementation of the Belt.Provider.delete_scope/3 callback

do_list_files(list, files, options)
get_info(config, identifier, options)

Implementation of the Belt.Provider.get_info/3 callback

get_url(arg1, identifier, arg3)

Implementation of the Belt.Provider.get_url/3 callback

list_files(config, options)

Implementation of the Belt.Provider.list_files/2 callback

new(opts)

Creates a new Filesystem provider configuration

store(config, file_source, options)

Implementation of the Belt.Provider.store/3 callback

store_data(config, iodata, options)

Implementation of the Belt.Provider.store_data/3 callback

test_connection(config, options)

Implementation of the Provider.test_connection/2 callback

Link to this section Types

Link to this type filesystem_option() View Source 
filesystem_option() :: {:directory, String.t()} | {:base_url, String.t()}

Options for creating an Filesystem provider.

Link to this section Functions

Link to this function default(options \\ []) View Source 
default([filesystem_option()]) ::
  {:ok, Belt.Provider.configuration()} | {:error, term()}

Creates a new Filesystem provider configuration with default credentials.

Any provided options override the default settings which are retrieved from the application configuration.

Example 

# config.exs
config :belt, Belt.Provider.Filesystem,
default: [
  directory: "/foo",
  base_url: "https://example.com/"]
Link to this function delete(config, identifier, options) View Source

Implementation of the Belt.Provider.delete/3 callback.

Link to this function delete_all(config, options) View Source

Implementation of the Belt.Provider.delete_all/2 callback.

Link to this function delete_scope(config, scope, options) View Source

Implementation of the Belt.Provider.delete_scope/3 callback.

Link to this function do_list_files(list, files, options) View Source
Link to this function get_info(config, identifier, options) View Source

Implementation of the Belt.Provider.get_info/3 callback.

Link to this function get_url(arg1, identifier, arg3) View Source

Implementation of the Belt.Provider.get_url/3 callback.

Link to this function list_files(config, options) View Source

Implementation of the Belt.Provider.list_files/2 callback.

Link to this function new(opts) View Source 
new([filesystem_option()]) :: {:ok, Belt.Provider.configuration()}

Creates a new Filesystem provider configuration.

Options

  • :directory (required) - Path.t - path to folder on the file system.
  • :base_url - String.t - URL under which files stored with this configuration are accessible
Link to this function store(config, file_source, options) View Source

Implementation of the Belt.Provider.store/3 callback.

Link to this function store_data(config, iodata, options) View Source

Implementation of the Belt.Provider.store_data/3 callback.

Link to this function test_connection(config, options) View Source

Implementation of the Provider.test_connection/2 callback.