binny-fs
API
Generated with
binny-fs/binny.fs

binny.fs

package binny.fs

Members list

Type members

Classlikes

trait DirectoryMapping

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object DirectoryMapping

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final class EmptyDirectoryRemove[F[_]](val baseDir: Path, targetFile: BinaryId => Path, logger: Logger[F])(implicit evidence$1: Files[F], evidence$2: Sync[F])

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object EmptyDirectoryRemove

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class FsBinaryStore[F[_]](val config: FsStoreConfig, logger: Logger[F])(implicit evidence$1: Async[F], evidence$2: Files[F]) extends BinaryStore[F]

Attributes

Companion
object
Supertypes
trait BinaryStore[F]
class Object
trait Matchable
class Any
object FsBinaryStore

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class FsBinaryStoreWithCleanup[F[_]] extends BinaryStore[F]

A variant of FsBinaryStore that will cleanup empty directories that could be left when deleting files.

A variant of FsBinaryStore that will cleanup empty directories that could be left when deleting files.

Since this deletion of directories could race against a concurrent inserting of a file, both operations are run sequentially. With this class there should be only one store working on the same base directory!

Attributes

Companion
object
Supertypes
trait BinaryStore[F]
class Object
trait Matchable
class Any
object FsBinaryStoreWithCleanup

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class FsChunkedBinaryStore[F[_]](val config: FsChunkedStoreConfig, logger: Logger[F])(implicit evidence$1: Async[F], evidence$2: Files[F]) extends ChunkedBinaryStore[F]

Stores binaries in chunks in the filesystem. When reading all available chunks are concatenated.

Stores binaries in chunks in the filesystem. When reading all available chunks are concatenated.

Attributes

Companion
object
Supertypes
trait ChunkedBinaryStore[F]
trait BinaryStore[F]
class Object
trait Matchable
class Any
object FsChunkedBinaryStore

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class FsChunkedBinaryStoreWithCleanup[F[_]] extends ChunkedBinaryStore[F]

Attributes

Companion
object
Supertypes
trait ChunkedBinaryStore[F]
trait BinaryStore[F]
class Object
trait Matchable
class Any
object FsChunkedBinaryStoreWithCleanup

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
case class FsChunkedStoreConfig(baseDir: Path, detect: ContentTypeDetect, overwriteMode: OverwriteMode, mapping: DirectoryMapping, chunkSize: Int, readChunkSize: Int)

Value parameters

baseDir

the base directory, everything is stored below

chunkSize

the size of each chunk file

detect

detect the content type of a binary when storing

mapping

the mapping from a BinaryId to a directory containing all the chunk files

overwriteMode

what to do when a file already exists

readChunkSize

used when reading chunk files, this may be set at maximum to chunkSize, but can be set smaller to use less memory when reading files

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FsChunkedStoreConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class FsStoreConfig(baseDir: Path, detect: ContentTypeDetect, overwriteMode: OverwriteMode, mapping: PathMapping, chunkSize: Int)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FsStoreConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait OverwriteMode

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Fail.type
object Replace.type
object Skip.type
object OverwriteMode

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait PathMapping

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object PathMapping

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Generated with