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

   FileStore → Store

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

    FileStore → Store

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, recursive: Boolean = false): Stream[F, Path]

    List paths.

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

    path

    to list

    recursive

    when true returned list would contain files at given path and all sub-folders but no folders, otherwise – return files and folder at given path.

    returns

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

    Definition Classes

    FileStore → Store

    Example:

    1. Given Path pointing at folder: folder/a folder/b folder/c folder/sub-folder/d folder/sub-folder/sub-sub-folder/e list(folder, recursive = true) -> [a, b, c, d, e] list(folder, recursive = false) -> [a, b, c, sub-folder]

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

    FileStore → Store

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, overwrite: Boolean = true): 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

    overwrite

    when true putting to path with pre-existing file would overwrite the content, otherwise – fail with error.

    returns

    sink of bytes

    Definition Classes

    FileStore → Store

21.  def putRotate(computePath: F[Path], limit: Long): Pipe[F, Byte, Unit]

    Writes all data to a sequence of blobs/files, each limited in size to limit.

    Writes all data to a sequence of blobs/files, each limited in size to limit.

    The computePath operation is used to compute the path of the first file and every subsequent file. Typically, the next file should be determined by analyzing the current state of the filesystem -- e.g., by looking at all files in a directory and generating a unique name.

    computePath

    operation to compute the path of the first file and all subsequent files.

    limit

    maximum size in bytes for each file.

    returns

    sink of bytes

    Definition Classes

    FileStore → Store

    Note

    Put of all files uses overwrite semantic, i.e. if path returned by computePath already exists content will be overwritten. If that doesn't suit your use case use computePath to guard against overwriting existing files.

22.  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

    FileStore → Store

23.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

24.  def toString(): String

    Definition Classes

    AnyRef → Any

25.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

26.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

27.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()