Fact.Seam.FileName behaviour (Fact v0.2.0)

View Source

Behaviour defining the contract for generating file names within the Fact system.

Implementations of this seam are responsible for producing a file name based on a given value and optional parameters. This allows flexible naming strategies that can be swapped or configured per database or file type.

Callback

  • get/3 – Generates a file name for the given value using the configured implementation and options. Returns {:ok, path} on success or {:error, reason} on failure.

Summary

Types

t()

Callbacks

default_options()
family()
get(state, value, opts)
id()
init(map)
normalize_options(map)
option_specs()
prepare_options(map)
version()

Types

t()

@type t() :: struct()

Callbacks

default_options()

@callback default_options() :: map()

family()

@callback family() :: atom()

get(state, value, opts)

@callback get(state :: t(), value :: term(), opts :: keyword()) ::
  {:ok, Path.t()} | {:error, term()}

id()

@callback id() :: {atom(), non_neg_integer()}

init(map)

@callback init(map()) :: struct() | {:error, term()}

normalize_options(map)

@callback normalize_options(map()) :: {:ok, map()} | {:error, term()}

option_specs()

@callback option_specs() :: %{required(atom()) => map()}

prepare_options(map)

@callback prepare_options(map()) :: map()

version()

@callback version() :: non_neg_integer()