Module locus_custom_fetcher

Behaviours: gen_server.

This module defines the locus_custom_fetcher behaviour.
Required callback functions: description/1, fetch/1, conditionally_fetch/2.

Data Types

description()

description() = #{database_is_stored_remotely := boolean(), database_is_fetched_from := term()}

event()

event() = event_load_attempt_started() | event_load_attempt_dismissed()

event_load_attempt_dismissed()

event_load_attempt_dismissed() = {load_attempt_dismissed, source()}

event_load_attempt_started()

event_load_attempt_started() = {load_attempt_started, source()}

msg()

msg() = {event, event()} | {finished, {success, success()}} | {finished, dismissed} | {finished, {error, term()}}

source()

source() = {local | remote, {custom, term()}}

success()

success() = #{format := locus_loader:blob_format(), content := binary(), metadata := successful_fetch_metadata()}

successful_fetch_metadata()

successful_fetch_metadata() = #{fetched_from := term(), modified_on := calendar:datetime() | unknown}


Generated by EDoc