Trait

blobstore

Store

Related Doc: package blobstore

Permalink

trait Store[F[_]] extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
FileStore
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Store
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(src: Path, dst: Path): F[Unit]

    Permalink

    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]

  2. abstract def get(path: Path, chunkSize: Int): Stream[F, Byte]

    Permalink

    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

  3. abstract def list(path: Path): Stream[F, Path]

    Permalink

    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.

  4. abstract def move(src: Path, dst: Path): F[Unit]

    Permalink

    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]

  5. abstract def put(path: Path): Pipe[F, Byte, Unit]

    Permalink

    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

  6. abstract def remove(path: Path): F[Unit]

    Permalink

    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]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped