FileStorageApi.Container behaviour (file_storage_api v2.4.0)

Module for handling asset containers

Summary

Types

options()

t()

Callbacks

create(t, arg2, map)

delete(t, arg2)

list_files(t, arg2, options)

Functions

create(container_name, opts \\ %{})

Will create container with binary as input for bucket name

delete(container_name, connection \\ :default)

list_files(container_name, options \\ [])

List all files in the container.

Types

options()

@type options() :: [
  {:max_results, non_neg_integer()}
  | {:marker, String.t()}
  | {:connection, atom() | map() | keyword()}
  | {atom(), term()}
]

t()

@type t() :: %FileStorageApi.Container{
  date: DateTime.t(),
  files: [FileStorageApi.File.t()],
  max_results: non_neg_integer(),
  name: String.t(),
  next_marker: String.t()
}

Callbacks

create(t, arg2, map)

@callback create(String.t(), atom() | map(), map()) :: {:ok, map()} | {:error, map()}

delete(t, arg2)

@callback delete(String.t(), atom() | map()) :: {:ok, map()} | {:error, map()}

list_files(t, arg2, options)

@callback list_files(String.t(), atom() | map(), options()) ::
  {:ok, [t()]} | {:error, map()}

Functions

create(container_name, opts \\ %{})

@spec create(String.t(), map()) :: any()

Will create container with binary as input for bucket name

Opts allows for setting cors_policy as map or true will only be applied to S3

delete(container_name, connection \\ :default)

@spec delete(String.t(), atom() | map()) :: any()

list_files(container_name, options \\ [])

@spec list_files(String.t(), options()) :: Enumerable.t()

List all files in the container.

Options are available for max_results: which can be adjusted.

It's build around stream so will automatically use the markers to get as many items as are in the bucket.