- Value parameters:
- api
underlying configured BoxAPIConnection
- blocker
cats-effect blocker.
- largeFileThreshold
override for the threshold on the file size to be considered "large", default – 50MiB
- rootFolderId
Root Folder Id, default – "0"
- Companion:
- object
Value members
Concrete methods
Copies bytes from srcPath to dstPath. Stores should optimize to use native copy functions to avoid data transfer.
Copies bytes from srcPath to dstPath. Stores should optimize to use native copy functions to avoid data transfer.
- Value parameters:
- dst
path
- src
path
- Returns:
F[Unit]
- Definition Classes
- PathStore
Get bytes for the given Path.
Get bytes for the given Path.
- Value parameters:
- chunkSize
bytes to read in each chunk.
- path
to get
- Returns:
stream of bytes
- Definition Classes
- PathStore
Lifts this FileStore to a Store accepting URLs with authority A and exposing blobs of type B. You must provide
a mapping from this Store's BlobType to B, and you may provide a function g for controlling input paths to this
store.
Lifts this FileStore to a Store accepting URLs with authority A and exposing blobs of type B. You must provide
a mapping from this Store's BlobType to B, and you may provide a function g for controlling input paths to this
store.
Input URLs to the returned store are validated against this Store's authority before the path is extracted and passed to this store.
- Definition Classes
- PathStore
List paths.
List paths.
- Value parameters:
- 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.
- Example:
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]
- Definition Classes
- PathStore
Moves bytes from srcPath to dstPath. Stores should optimize to use native move functions to avoid data transfer.
Moves bytes from srcPath to dstPath. Stores should optimize to use native move functions to avoid data transfer.
- Value parameters:
- dst
path
- src
path
- Returns:
F[Unit]
- Definition Classes
- PathStore
Provides a Sink that writes bytes into the provided path.
Provides a Sink that writes bytes into the provided path.
- Value parameters:
- overwrite
when true putting to path with pre-existing file would overwrite the content, otherwise – fail with error.
- path
to put
- Returns:
sink of bytes
- Definition Classes
- PathStore
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 computeUrl 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.
- Value parameters:
- 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
- Note:
Put of all files uses overwrite semantic, i.e. if path returned by computeUrl already exists content will be overwritten. If that doesn't suit your use case use computeUrl to guard against overwriting existing files.
- Definition Classes
- PathStore
Remove bytes for given path. Call should succeed even if there is nothing stored at that path.
Remove bytes for given path. Call should succeed even if there is nothing stored at that path.
- Value parameters:
- url
to remove
- Returns:
F[Unit]
- Definition Classes
- PathStore
- Definition Classes
- PathStore