locus_filesystem_load (locus v2.3.14)

View Source

Loads a file from the filesystem without blocking the caller

Summary

Types

event/0
event_load_attempt_dismissed/0
event_load_attempt_started/0
msg/0
path/0
source/0
state/0
success/0

Types

event/0

-type event() :: event_load_attempt_started() | event_load_attempt_dismissed().

event_load_attempt_dismissed/0

-type event_load_attempt_dismissed() :: {load_attempt_dismissed, source()}.

event_load_attempt_started/0

-type event_load_attempt_started() :: {load_attempt_started, source()}.

msg/0

-type msg() ::
          {event, event()} |
          {finished, {success, success()}} |
          {finished, dismissed} |
          {finished, {error, not_found}} |
          {finished, {error, term()}}.

path/0

-type path() :: file:filename_all().

source/0

-type source() :: {cache | filesystem, path()}.

state/0

-opaque state()

success/0

-type success() :: #{modified_on := calendar:datetime(), content := binary()}.