From 0b4d9bd2f939942e0b75bc7a854c4f331adce4b5 Mon Sep 17 00:00:00 2001 From: favonia Date: Tue, 31 Oct 2023 15:16:34 +0000 Subject: [PATCH] deploy: 273453a9c219fec812d5f6c54102c4eb073a5d72 --- algaeff/Algaeff/Reader/Make/index.html | 2 +- algaeff/Algaeff/Reader/index.html | 2 +- algaeff/Algaeff/Reader/module-type-S/Env/index.html | 2 -- algaeff/Algaeff/Reader/module-type-S/index.html | 2 +- algaeff/Algaeff/Sequencer/index.html | 2 +- algaeff/Algaeff/Sequencer/module-type-S/Elt/index.html | 2 -- algaeff/Algaeff/Sequencer/module-type-S/index.html | 2 +- algaeff/Algaeff/State/Make/index.html | 2 +- algaeff/Algaeff/State/index.html | 2 +- algaeff/Algaeff/State/module-type-S/State/index.html | 2 -- algaeff/Algaeff/State/module-type-S/index.html | 2 +- algaeff/Algaeff/UniqueID/index.html | 2 +- algaeff/Algaeff/UniqueID/module-type-S/Elt/index.html | 2 -- algaeff/Algaeff/UniqueID/module-type-S/index.html | 4 ++-- 14 files changed, 11 insertions(+), 19 deletions(-) delete mode 100644 algaeff/Algaeff/Reader/module-type-S/Env/index.html delete mode 100644 algaeff/Algaeff/Sequencer/module-type-S/Elt/index.html delete mode 100644 algaeff/Algaeff/State/module-type-S/State/index.html delete mode 100644 algaeff/Algaeff/UniqueID/module-type-S/Elt/index.html diff --git a/algaeff/Algaeff/Reader/Make/index.html b/algaeff/Algaeff/Reader/Make/index.html index 05ad2f4..e91f5ab 100644 --- a/algaeff/Algaeff/Reader/Make/index.html +++ b/algaeff/Algaeff/Reader/Make/index.html @@ -1,2 +1,2 @@ -Make (algaeff.Algaeff.Reader.Make)

Module Reader.Make

The implementation of read effects.

Signatures of read effects.

Parameters

module Env : Sigs.Type

Signature

val read : unit -> Env.t

Read the environment.

val scope : (Env.t -> Env.t) -> (unit -> 'a) -> 'a

scope f t runs the thunk t under the new environment that is the result of applying f to the current environment.

val run : env:Env.t -> (unit -> 'a) -> 'a

run t runs the thunk t which may perform reading effects.

val register_printer : ([ `Read ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert the unhandled internal effect into a string for the OCaml runtime system to display. Ideally, the internal effect should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor Reader.Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the only internal effect used in this module. It corresponds to the effect trigger by read.

  • since 1.1.0
+Make (algaeff.Algaeff.Reader.Make)

Module Reader.Make

The implementation of read effects.

Signatures of read effects.

Parameters

module Env : Sigs.Type

Signature

val read : unit -> Env.t

Read the environment.

val scope : (Env.t -> Env.t) -> (unit -> 'a) -> 'a

scope f t runs the thunk t under the new environment that is the result of applying f to the current environment.

val run : env:Env.t -> (unit -> 'a) -> 'a

run ~env t runs the thunk t which may perform reading effects on the value env.

val register_printer : ([ `Read ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert the unhandled internal effect into a string for the OCaml runtime system to display. Ideally, the internal effect should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor Reader.Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the only internal effect used in this module. It corresponds to the effect trigger by read.

  • since 1.1.0
diff --git a/algaeff/Algaeff/Reader/index.html b/algaeff/Algaeff/Reader/index.html index fde2ccf..536bee9 100644 --- a/algaeff/Algaeff/Reader/index.html +++ b/algaeff/Algaeff/Reader/index.html @@ -9,4 +9,4 @@ R.scope (fun i -> i + 1) (fun () -> print_int (R.read ())); (* this will print out 42 again *) - print_int (R.read ())

This should be equivalent to Unmonad applying to the standard reader monad.

module type S = sig ... end

Signatures of read effects.

module Make (Env : Sigs.Type) : S with module Env := Env

The implementation of read effects.

+ print_int (R.read ())
module type S = sig ... end

Signatures of read effects.

module Make (Env : Sigs.Type) : S with type env := Env.t

The implementation of read effects.

diff --git a/algaeff/Algaeff/Reader/module-type-S/Env/index.html b/algaeff/Algaeff/Reader/module-type-S/Env/index.html deleted file mode 100644 index 3da2ef2..0000000 --- a/algaeff/Algaeff/Reader/module-type-S/Env/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Env (algaeff.Algaeff.Reader.S.Env)

Module S.Env

Type of environments.

type t

The type.

diff --git a/algaeff/Algaeff/Reader/module-type-S/index.html b/algaeff/Algaeff/Reader/module-type-S/index.html index 11532b6..a7e40f0 100644 --- a/algaeff/Algaeff/Reader/module-type-S/index.html +++ b/algaeff/Algaeff/Reader/module-type-S/index.html @@ -1,2 +1,2 @@ -S (algaeff.Algaeff.Reader.S)

Module type Reader.S

Signatures of read effects.

module Env : Sigs.Type

Type of environments.

val read : unit -> Env.t

Read the environment.

val scope : (Env.t -> Env.t) -> (unit -> 'a) -> 'a

scope f t runs the thunk t under the new environment that is the result of applying f to the current environment.

val run : env:Env.t -> (unit -> 'a) -> 'a

run t runs the thunk t which may perform reading effects.

val register_printer : ([ `Read ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert the unhandled internal effect into a string for the OCaml runtime system to display. Ideally, the internal effect should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor Reader.Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the only internal effect used in this module. It corresponds to the effect trigger by read.

  • since 1.1.0
+S (algaeff.Algaeff.Reader.S)

Module type Reader.S

Signatures of read effects.

type env

The type of environments.

val read : unit -> env

Read the environment.

val scope : (env -> env) -> (unit -> 'a) -> 'a

scope f t runs the thunk t under the new environment that is the result of applying f to the current environment.

val run : env:env -> (unit -> 'a) -> 'a

run ~env t runs the thunk t which may perform reading effects on the value env.

val register_printer : ([ `Read ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert the unhandled internal effect into a string for the OCaml runtime system to display. Ideally, the internal effect should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor Reader.Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the only internal effect used in this module. It corresponds to the effect trigger by read.

  • since 1.1.0
diff --git a/algaeff/Algaeff/Sequencer/index.html b/algaeff/Algaeff/Sequencer/index.html index 8f58d8f..5e76b91 100644 --- a/algaeff/Algaeff/Sequencer/index.html +++ b/algaeff/Algaeff/Sequencer/index.html @@ -5,4 +5,4 @@ let seq : int Seq.t = S.run @@ fun () -> S.yield 1; S.yield 2; S.yield 3 (* An implementation of [List.to_seq]. *) -let to_seq l : int Seq.t = S.run @@ fun () -> List.iter S.yield l

The sequencers are generators for Seq.t.

module type S = sig ... end

Signatures of sequencing effects.

module Make (Elt : Sigs.Type) : S with module Elt := Elt

The implementation of sequencing effects.

+let to_seq l : int Seq.t = S.run @@ fun () -> List.iter S.yield l

The sequencers are generators for Seq.t.

module type S = sig ... end

Signatures of sequencing effects.

module Make (Elt : Sigs.Type) : S with type elt := Elt.t

The implementation of sequencing effects.

diff --git a/algaeff/Algaeff/Sequencer/module-type-S/Elt/index.html b/algaeff/Algaeff/Sequencer/module-type-S/Elt/index.html deleted file mode 100644 index 4ecc58f..0000000 --- a/algaeff/Algaeff/Sequencer/module-type-S/Elt/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Elt (algaeff.Algaeff.Sequencer.S.Elt)

Module S.Elt

type t

The type.

diff --git a/algaeff/Algaeff/Sequencer/module-type-S/index.html b/algaeff/Algaeff/Sequencer/module-type-S/index.html index ba41c39..8d0de19 100644 --- a/algaeff/Algaeff/Sequencer/module-type-S/index.html +++ b/algaeff/Algaeff/Sequencer/module-type-S/index.html @@ -1,2 +1,2 @@ -S (algaeff.Algaeff.Sequencer.S)

Module type Sequencer.S

Signatures of sequencing effects.

module Elt : Sigs.Type
val yield : Elt.t -> unit

Yield the element.

val run : (unit -> unit) -> Elt.t Stdlib.Seq.t

run t runs the thunk t which may perform sequencing effects.

val register_printer : ([ `Yield of Elt.t ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert unhandled internal effects into strings for the OCaml runtime system to display. Ideally, all internal effects should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor Sequencer.Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the internal effects used in this module. They correspond to the effects trigger by yield. More precisely, `Yield elt corresponds to the effect triggered by yield elt.

  • since 1.1.0
+S (algaeff.Algaeff.Sequencer.S)

Module type Sequencer.S

Signatures of sequencing effects.

type elt

The type of elements.

val yield : elt -> unit

Yield the element.

val run : (unit -> unit) -> elt Stdlib.Seq.t

run t runs the thunk t which may perform sequencing effects.

val register_printer : ([ `Yield of elt ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert unhandled internal effects into strings for the OCaml runtime system to display. Ideally, all internal effects should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor Sequencer.Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the internal effects used in this module. They correspond to the effects trigger by yield. More precisely, `Yield elt corresponds to the effect triggered by yield elt.

  • since 1.1.0
diff --git a/algaeff/Algaeff/State/Make/index.html b/algaeff/Algaeff/State/Make/index.html index 92226d6..30a836e 100644 --- a/algaeff/Algaeff/State/Make/index.html +++ b/algaeff/Algaeff/State/Make/index.html @@ -1,2 +1,2 @@ -Make (algaeff.Algaeff.State.Make)

Module State.Make

The implementation of state effects.

Signatures of read effects.

Parameters

module State : Sigs.Type

Signature

val get : unit -> State.t

get () reads the current state.

val set : State.t -> unit

set x makes x the new state.

val modify : (State.t -> State.t) -> unit

modify f applies f to the current state and then set the result as the new state.

val run : init:State.t -> (unit -> 'a) -> 'a

run t runs the thunk t which may perform state effects.

val register_printer : ([ `Get | `Set of State.t ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert unhandled internal effects into strings for the OCaml runtime system to display. Ideally, all internal effects should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor State.Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the internal effects used in this module. They correspond to the effects trigger by get and set. More precisely,

  • `Get corresponds to the effect triggered by get ().
  • `Set state corresponds to the effect triggered by set state.
  • since 1.1.0
+Make (algaeff.Algaeff.State.Make)

Module State.Make

The implementation of state effects.

Signatures of read effects.

Parameters

module State : Sigs.Type

Signature

val get : unit -> State.t

get () reads the current state.

val set : State.t -> unit

set x makes x the new state.

val modify : (State.t -> State.t) -> unit

modify f applies f to the current state and then set the result as the new state.

val run : init:State.t -> (unit -> 'a) -> 'a

run ~init t runs the thunk t which may perform state effects. The initial state is init.

val register_printer : ([ `Get | `Set of State.t ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert unhandled internal effects into strings for the OCaml runtime system to display. Ideally, all internal effects should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the internal effects used in this module. They correspond to the effects trigger by get and set. More precisely,

  • `Get corresponds to the effect triggered by get ().
  • `Set state corresponds to the effect triggered by set state.
  • since 1.1.0
diff --git a/algaeff/Algaeff/State/index.html b/algaeff/Algaeff/State/index.html index fefd7f4..8eb0155 100644 --- a/algaeff/Algaeff/State/index.html +++ b/algaeff/Algaeff/State/index.html @@ -4,4 +4,4 @@ let forty_two = S.run ~init:100 @@ fun () -> print_int (S.get ()); (* this will print out 100 *) S.set 42; - S.get ()

This should be equivalent to Unmonad applying to the standard state monad when continuations are one-shot. (The current implementation uses mutable references and this statement has not been formally proved.)

module type S = sig ... end

Signatures of read effects.

module Make (State : Sigs.Type) : S with module State := State

The implementation of state effects.

+ S.get ()
module type S = sig ... end

Signatures of read effects.

module Make (State : Sigs.Type) : S with type state := State.t

The implementation of state effects.

diff --git a/algaeff/Algaeff/State/module-type-S/State/index.html b/algaeff/Algaeff/State/module-type-S/State/index.html deleted file mode 100644 index d93ee0c..0000000 --- a/algaeff/Algaeff/State/module-type-S/State/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -State (algaeff.Algaeff.State.S.State)

Module S.State

type t

The type.

diff --git a/algaeff/Algaeff/State/module-type-S/index.html b/algaeff/Algaeff/State/module-type-S/index.html index fa004ba..9190913 100644 --- a/algaeff/Algaeff/State/module-type-S/index.html +++ b/algaeff/Algaeff/State/module-type-S/index.html @@ -1,2 +1,2 @@ -S (algaeff.Algaeff.State.S)

Module type State.S

Signatures of read effects.

module State : Sigs.Type
val get : unit -> State.t

get () reads the current state.

val set : State.t -> unit

set x makes x the new state.

val modify : (State.t -> State.t) -> unit

modify f applies f to the current state and then set the result as the new state.

val run : init:State.t -> (unit -> 'a) -> 'a

run t runs the thunk t which may perform state effects.

val register_printer : ([ `Get | `Set of State.t ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert unhandled internal effects into strings for the OCaml runtime system to display. Ideally, all internal effects should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor State.Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the internal effects used in this module. They correspond to the effects trigger by get and set. More precisely,

  • `Get corresponds to the effect triggered by get ().
  • `Set state corresponds to the effect triggered by set state.
  • since 1.1.0
+S (algaeff.Algaeff.State.S)

Module type State.S

Signatures of read effects.

type state

The type of states.

val get : unit -> state

get () reads the current state.

val set : state -> unit

set x makes x the new state.

val modify : (state -> state) -> unit

modify f applies f to the current state and then set the result as the new state.

val run : init:state -> (unit -> 'a) -> 'a

run ~init t runs the thunk t which may perform state effects. The initial state is init.

val register_printer : ([ `Get | `Set of state ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert unhandled internal effects into strings for the OCaml runtime system to display. Ideally, all internal effects should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the internal effects used in this module. They correspond to the effects trigger by get and set. More precisely,

  • `Get corresponds to the effect triggered by get ().
  • `Set state corresponds to the effect triggered by set state.
  • since 1.1.0
diff --git a/algaeff/Algaeff/UniqueID/index.html b/algaeff/Algaeff/UniqueID/index.html index 23c887e..c5aab1b 100644 --- a/algaeff/Algaeff/UniqueID/index.html +++ b/algaeff/Algaeff/UniqueID/index.html @@ -1,2 +1,2 @@ -UniqueID (algaeff.Algaeff.UniqueID)

Module Algaeff.UniqueID

Effects for generating unique IDs.

Generate unique IDs for registered items.

module type S = sig ... end

Signatures of the effects.

module Make (Elt : Sigs.Type) : S with module Elt := Elt

The implementation of the effects.

+UniqueID (algaeff.Algaeff.UniqueID)

Module Algaeff.UniqueID

Effects for generating unique IDs.

Generate unique IDs for registered items.

module type S = sig ... end

Signatures of the effects.

module Make (Elt : Sigs.Type) : S with type elt := Elt.t

The implementation of the effects.

diff --git a/algaeff/Algaeff/UniqueID/module-type-S/Elt/index.html b/algaeff/Algaeff/UniqueID/module-type-S/Elt/index.html deleted file mode 100644 index fecacc2..0000000 --- a/algaeff/Algaeff/UniqueID/module-type-S/Elt/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Elt (algaeff.Algaeff.UniqueID.S.Elt)

Module S.Elt

type t

The type.

diff --git a/algaeff/Algaeff/UniqueID/module-type-S/index.html b/algaeff/Algaeff/UniqueID/module-type-S/index.html index 0024cf3..fde3360 100644 --- a/algaeff/Algaeff/UniqueID/module-type-S/index.html +++ b/algaeff/Algaeff/UniqueID/module-type-S/index.html @@ -1,4 +1,4 @@ -S (algaeff.Algaeff.UniqueID.S)

Module type UniqueID.S

Signatures of the effects.

module Elt : Sigs.Type
module ID : sig ... end

The type of IDs and its friends.

type id = ID.t

The type of unique IDs. The client should not assume a particular indexing scheme.

val register : Elt.t -> id

Register a new item and get an ID. Note that registering the same item twice will get two different IDs.

val retrieve : id -> Elt.t

Retrieve the item associated with the ID.

val export : unit -> Elt.t Stdlib.Seq.t

Export the internal storage for serialization. Once exported, the representation is persistent and can be traversed without the effect handler.

val run : ?init:Elt.t Stdlib.Seq.t -> (unit -> 'a) -> 'a

run t runs the thunk t and handles the effects for generating unique IDs.

  • parameter init

    The initial storage, which should be the output of some previous export.

val register_printer : - ([ `Register of Elt.t | `Retrieve of id | `Export ] -> string option) -> +S (algaeff.Algaeff.UniqueID.S)

Module type UniqueID.S

Signatures of the effects.

type elt

The type of elements

module ID : sig ... end

The type of IDs and its friends.

type id = ID.t

The type of unique IDs. The client should not assume a particular indexing scheme.

val register : elt -> id

Register a new item and get an ID. Note that registering the same item twice will get two different IDs.

val retrieve : id -> elt

Retrieve the item associated with the ID.

val export : unit -> elt Stdlib.Seq.t

Export the internal storage for serialization. Once exported, the representation is persistent and can be traversed without the effect handler.

val run : ?init:elt Stdlib.Seq.t -> (unit -> 'a) -> 'a

run t runs the thunk t and handles the effects for generating unique IDs.

  • parameter init

    The initial storage, which should be the output of some previous export.

val register_printer : + ([ `Register of elt | `Retrieve of id | `Export ] -> string option) -> unit

register_printer p registers a printer p via Printexc.register_printer to convert unhandled internal effects into strings for the OCaml runtime system to display. Ideally, all internal effects should have been handled by run and there is no need to use this function, but when it is not the case, this function can be helpful for debugging. The functor UniqueID.Make always registers a simple printer to suggest using run, but you can register new ones to override it. The return type of the printer p should return Some s where s is the resulting string, or None if it chooses not to convert a particular effect. The registered printers are tried in reverse order until one of them returns Some s for some s; that is, the last registered printer is tried first. Note that this function is a wrapper of Printexc.register_printer and all the registered printers (via this function or Printexc.register_printer) are put into the same list.

The input type of the printer p is a variant representation of the internal effects used in this module. They correspond to the effects trigger by register, retrieve and export. More precisely,

  • `Register elt corresponds to the effect triggered by register elt.
  • `Retrieve id corresponds to the effect triggered by retrieve id.
  • `Export corresponds to the effect triggered by export ().
  • since 1.1.0