View Source grisp_updater_progress behaviour (grisp_updater v2.1.0)

Summary

Types

-type statistics() ::
          #{start_time := non_neg_integer(),
            blocks_total := non_neg_integer(),
            blocks_checked := non_neg_integer(),
            blocks_loading := non_neg_integer(),
            blocks_loaded := non_neg_integer(),
            blocks_retries := non_neg_integer(),
            blocks_written := non_neg_integer(),
            data_total := non_neg_integer(),
            data_checked := non_neg_integer(),
            data_loaded := non_neg_integer(),
            data_skipped := non_neg_integer(),
            data_written := non_neg_integer()}.

Callbacks

-callback progress_done(State :: term(), Statistics :: statistics()) -> ok.
-callback progress_error(State :: term(),
                         Statistics :: statistics(),
                         Reason :: term(),
                         Msg :: binary() | undefined) ->
                            ok.
-callback progress_init(Opts :: map()) -> {ok, State :: term()} | {error, term()}.
-callback progress_update(State :: term(), Statistics :: statistics()) -> {ok, State :: term()}.
-callback progress_warning(State :: term(), Reason :: term(), Msg :: binary() | undefined) ->
                              {ok, State :: term()}.

Functions