Source file store_properties_intf.ml

(*
 * Copyright (c) 2013-2022 Thomas Gazagnaire <thomas@gazagnaire.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

open Import

module type Batch = sig
  type 'a t

  val batch : read t -> ([ read | write ] t -> 'a Lwt.t) -> 'a Lwt.t
  (** [batch t f] applies the writes in [f] in a separate batch. The exact
      guarantees depend on the implementation. *)
end

module type Closeable = sig
  type 'a t

  val close : 'a t -> unit Lwt.t
  (** [close t] frees up all the resources associated with [t]. Any operations
      run on a closed handle will raise [Closed]. *)
end

module type Of_config = sig
  type 'a t

  val v : Conf.t -> read t Lwt.t
  (** [v config] is a function returning fresh store handles, with the
      configuration [config], which is provided by the backend. *)
end

module type Clearable = sig
  type 'a t

  val clear : 'a t -> unit Lwt.t
  (** Clear the store. This operation is expected to be slow. *)
end

module type Sigs = sig
  exception Closed

  module type Batch = sig
    include Batch
    (** @inline *)
  end

  module type Closeable = sig
    include Closeable
    (** @inline *)
  end

  module type Of_config = sig
    include Of_config
    (** @inline *)
  end

  module type Clearable = sig
    include Clearable
    (** @inline *)
  end
end