locus v2.3.3

View Source locus_filesystem_load (locus v2.3.3)

Loads a file from the filesystem without blocking the caller

Link to this section Summary

Types

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

Functions

code_change(OldVsn, State, Extra)
handle_call(Call, From, State)
handle_cast(Cast, State)
handle_info(Info, State)
init(_)
start_link(Source, PrevModificationDT)
terminate(Reason, State)

Link to this section Types

Link to this type

event/0

View Source

Specs

event() :: event_load_attempt_started() | event_load_attempt_dismissed().
Link to this type

event_load_attempt_dismissed/0

View Source

Specs

event_load_attempt_dismissed() :: {load_attempt_dismissed, source()}.
Link to this type

event_load_attempt_started/0

View Source

Specs

event_load_attempt_started() :: {load_attempt_started, source()}.
Link to this type

msg/0

View Source

Specs

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

path/0

View Source

Specs

path() :: nonempty_string().
Link to this type

source/0

View Source

Specs

source() :: {cache | filesystem, path()}.
Link to this type

state/0

View Source

Specs

state() :: #state{}.
Link to this type

success/0

View Source

Specs

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

Link to this section Functions

Link to this function

code_change(OldVsn, State, Extra)

View Source

Specs

code_change(term(), state(), term()) -> {ok, state()}.
Link to this function

handle_call(Call, From, State)

View Source

Specs

handle_call(term(), {pid(), reference()}, state()) -> {stop, unexpected_call, state()}.
Link to this function

handle_cast(Cast, State)

View Source

Specs

handle_cast(term(), state()) -> {stop, unexpected_cast, state()}.
Link to this function

handle_info(Info, State)

View Source

Specs

handle_info(term(), state()) -> {stop, normal, state()} | {stop, unexpected_info, state()}.
Link to this function

init(_)

View Source

Specs

init([InitArg, ...]) -> {ok, state()}
        when
            InitArg :: OwnerPid | Source | PrevModificationDT,
            OwnerPid :: pid(),
            Source :: source(),
            PrevModificationDT :: calendar:datetime() | unknown.
Link to this function

start_link(Source, PrevModificationDT)

View Source

Specs

start_link(source(), calendar:datetime() | unknown) -> {ok, pid()}.
Link to this function

terminate(Reason, State)

View Source

Specs

terminate(term(), state()) -> ok.