Packages

c

blobstore

StoreOps

class StoreOps[F[_], A <: Authority, B] extends AnyRef

This object contains shared implementations of functions that requires additional capabilities from the effect type

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StoreOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StoreOps(store: Store[F, A, B])(implicit arg0: Sync[F], arg1: 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def bufferedPut(url: Url[A], overwrite: Boolean, chunkSize: Int, blocker: Blocker): Pipe[F, Byte, Unit]

    Put sink that buffers all incoming bytes to local filesystem, computes buffered data size, then puts bytes to store.

    Put sink that buffers all incoming bytes to local filesystem, computes buffered data size, then puts bytes to store. Useful when uploading data to stores that require content size like S3Store.

    url

    Path to write to

    returns

    Sink[F, Byte] buffered sink

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def get(src: Url[A], dst: Path, chunkSize: Int, blocker: Blocker): F[Unit]

    get src path and write to local file system

    get src path and write to local file system

    src

    Path to get

    dst

    local file to write contents to

    returns

    F[Unit]

  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def getContents(url: Url[A], chunkSize: Int, decoder: Pipe[F, Byte, String]): F[String]

    Decode get bytes from path into a string using decoder and return concatenated string.

    Decode get bytes from path into a string using decoder and return concatenated string.

    USE WITH CARE, this loads all file contents into memory.

    url

    Path to get

    decoder

    Pipe[F, Byte, String]

    returns

    F[String] with file contents

  12. def getContents(url: Url[A], chunkSize: Int = 4096): F[String]

    getContents with default UTF8 decoder

    getContents with default UTF8 decoder

    url

    Path to get

    returns

    F[String] with file contents

  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def listAll(url: Url[A]): F[List[Path[B]]]

    Collect all list results in the same order as the original list Stream

    Collect all list results in the same order as the original list Stream

    url

    Path to list

    returns

    F\[List\[Path\]\] with all items in the result

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def put(src: Path, dst: Url[A], overwrite: Boolean, blocker: Blocker): F[Unit]

    Write contents of src file into dst Path

    Write contents of src file into dst Path

    src

    java.nio.file.Path

    dst

    Path to write to

    returns

    F[Unit]

  20. def removeAll(url: Url[A])(implicit ev: <:<[B, FsObject]): F[Int]

    Remove all files from a store recursively, given a path

  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def transferTo[AA <: Authority, BB](dstStore: Store[F, AA, BB], srcUrl: Url[A], dstUrl: Url[AA]): F[Int]

    Copy value of the given path in this store to the destination store.

    Copy value of the given path in this store to the destination store.

    This is especially useful when transferring content into S3Store that requires to know content size before starting content upload.

    This method will list items from srcPath, get the file size and put into dstStore with the given size. If listing contents result in nested directories it will copy files inside dirs recursively.

    dstStore

    destination store

    srcUrl

    path to transfer from (can be a path to a file or dir)

    dstUrl

    path to transfer to (can be a path to a file or dir, if you are transferring multiple files, make sure that dstPath.isDir == true, otherwise all files will override destination.

    returns

    Stream[F, Int] number of files transfered

  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped