Packages

final class FileStore[F[_]] extends Store[F]

Linear Supertypes
Store[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileStore
  2. Store
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FileStore(fsroot: java.nio.file.Path, blocker: Blocker)(implicit F: Sync[F], CS: ContextShift[F])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val absRoot: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def copy(src: Path, dst: Path): F[Unit]

    Copies bytes from srcPath to dstPath.

    Copies bytes from srcPath to dstPath. Stores should optimize to use native copy functions to avoid data transfer.

    src

    path

    dst

    path

    returns

    F[Unit]

    Definition Classes
    FileStoreStore
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. def get(path: Path, chunkSize: Int): Stream[F, Byte]

    Get bytes for the given Path.

    Get bytes for the given Path. See StoreOps.GetOps for convenient get and getContents methods.

    path

    to get

    chunkSize

    bytes to read in each chunk.

    returns

    stream of bytes

    Definition Classes
    FileStoreStore
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def list(path: Path): Stream[F, Path]

    List paths.

    List paths. See StoreOps.ListOps for convenient listAll method.

    path

    to list

    returns

    stream of Paths. Implementing stores must guarantee that returned Paths have correct values for size, isDir and lastModified.

    Definition Classes
    FileStoreStore
  16. def move(src: Path, dst: Path): F[Unit]

    Moves bytes from srcPath to dstPath.

    Moves bytes from srcPath to dstPath. Stores should optimize to use native move functions to avoid data transfer.

    src

    path

    dst

    path

    returns

    F[Unit]

    Definition Classes
    FileStoreStore
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. def put(path: Path): Pipe[F, Byte, Unit]

    Provides a Sink that writes bytes into the provided path.

    Provides a Sink that writes bytes into the provided path. See StoreOps.PutOps for convenient put String and put file methods.

    It is highly recommended to provide Path.size when writing as it allows for optimizations in some store. Specifically, S3Store will behave very poorly if no size is provided as it will load all bytes in memory before writing content to S3 server.

    path

    to put

    returns

    sink of bytes

    Definition Classes
    FileStoreStore
  21. def remove(path: Path): F[Unit]

    Remove bytes for given path.

    Remove bytes for given path. Call should succeed even if there is nothing stored at that path.

    path

    to remove

    returns

    F[Unit]

    Definition Classes
    FileStoreStore
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Store[F]

Inherited from AnyRef

Inherited from Any

Ungrouped