BoxStore

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 boxFileAtPath(path: Path): Option[BoxFile]

   

6. def boxFolderAtPath(path: Path): Option[BoxFolder]

   

7. def boxItemAtPath(parentFolder: BoxFolder, pathParts: List[String]): Option[BoxItem]

   

8. def boxItemAtPath(path: Path): Option[BoxItem]

   

9. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

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

    

    Copies file from srcPath to dstPath.

    Copies file 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

    BoxStore → Store

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

    

    Definition Classes

    AnyRef

12. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

13. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

14. 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

    BoxStore → Store

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

    

    Definition Classes

    AnyRef → Any

16. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

17. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

18. 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

    BoxStore → Store

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

    

    Moves file from srcPath to dstPath.

    Moves file 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

    BoxStore → Store

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

    

    Definition Classes

    AnyRef

21. final def notify(): Unit

    

    Definition Classes

    AnyRef

22. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

23. 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.

    path

    to put

    returns

    sink of bytes. This throws an exception if a file at this path already exists.

    Definition Classes

    BoxStore → Store

24. def putFolderAtPath(parentFolder: BoxFolder, pathParts: List[String]): BoxFolder

    

    Creates a BoxFolder at this path and all folders along this path.

    Creates a BoxFolder at this path and all folders along this path. If the path already exists, this will simply traverse the path and return the folder at this path. NOTE: this method makes Box API calls

    returns

    a BoxFolder at this path

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

    

    Remove file for given path.

    Remove file for given path.

    path

    to remove

    returns

    F[Unit]

    Definition Classes

    BoxStore → Store

26. val rootFolder: BoxFolder

    

27. def splitPath(path: Path): (List[String], String)

    

    Helper method to split a path into a list representing its folder path, and a string representing its file name.

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

    

    Definition Classes

    AnyRef

29. def toString(): String

    

    Definition Classes

    AnyRef → Any

30. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )