OgEx.ResourceLoader behaviour (og_ex v0.2.0)

Copy Markdown View Source

Behaviour for loading normalized image sources.

Implement this behaviour to read images from authenticated storage, replace the HTTP policy, or provide fixtures. Configure the implementation with:

config :og_ex, resource_loader: MyApp.OgResourceLoader

A loader is responsible for returning verified metadata and encoded bytes. Custom implementations can delegate byte verification to OgEx.ResourceLoader.Default.from_bytes/2.

Summary

Callbacks

load(t, keyword)

Loads one source and returns verified encoded bytes and metadata.

Callbacks

load(t, keyword)

@callback load(
  OgEx.Image.Source.t(),
  keyword()
) :: {:ok, OgEx.Image.Resource.t()} | {:error, term()}

Loads one source and returns verified encoded bytes and metadata.

Failures return {:error, reason}. Loaders should not raise for expected missing, policy, timeout, or validation failures.