de.sciss.lucre.DataStore.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lucre-core_3 Show documentation

Extension of Scala-STM, adding optional durability layer, and providing API for confluent and reactive event layers

The newest version!

/*
 *  DataStore.scala
 *  (Lucre 4)
 *
 *  Copyright (c) 2009-2024 Hanns Holger Rutz. All rights reserved.
 *
 *  This software is published under the GNU Affero General Public License v3+
 *
 *
 *  For further information, please contact Hanns Holger Rutz at
 *  [email protected]
 */

package de.sciss.lucre

import java.io.Closeable

import de.sciss.serial.{DataInput, DataOutput}

object DataStore {
  trait Factory {
    /** Opens a new database within the given storage environment.
     *
     * @param name       the name of the database
     * @param overwrite  whether to overwrite (`true`) an existing database by that name if it exists,
     *                   or not (`false`, default)
     * @return           the newly opened database
     */
    def open(name: String, overwrite: Boolean = false): DataStore
  }
}
trait DataStore extends Closeable {
  def put     (keyFun: DataOutput => Unit)(valueFun: DataOutput => Unit)(implicit tx: TxnLike): Unit
  def get[A]  (keyFun: DataOutput => Unit)(valueFun: DataInput  => A   )(implicit tx: TxnLike): Option[A]
  def contains(keyFun: DataOutput => Unit)(implicit tx: TxnLike): Boolean
  def remove  (keyFun: DataOutput => Unit)(implicit tx: TxnLike): Boolean

  def flatGet[A](keyFun: DataOutput => Unit)(valueFun: DataInput => Option[A])(implicit tx: TxnLike) : Option[A]

  def numEntries(implicit tx: TxnLike): Int
}