# Packages
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
GetOpts - iterate the inbound Options and return a struct.
WithBuffer sets the buffer size.
WithCloseSyncMode sets how a file is synced when closed.
WithCreateFile indicates a file should be created when opening.
WithFileAccessMode sets the access mode when a file is opened.
WithMinimumAvailableDiskSpace sets the minimum amount of available disk space a worker needs in the local path defined for processing sessions with recording enabled.
# Constants
Asynchronous mode will trigger a file to sync to the storage bucket on a recurring interval once it has been closed.
DefaultMinimumAvailableDiskSpace is the default value a Boundary worker will use if the user does not configure the worker with a RecordingStorageMinimumAvailableCapacity value.
No description provided by the author
LogicalBlockSize represents a single logical address, which is equivalent to 4,096 bytes (4 KiB)
A logical block is the minimum block that any file can allocate.
NoSync mode will result in Close not syncing the file to the storage bucket.
ReadOnly mode will open a file as read only.
ReadWrite mode will open a file for reading and writing.
Synchronous mode will cause a file closed call to block until the file has been synced to the storage bucket.
WriteOnly mode will open a file for writing only.
# Interfaces
Bucket is a resource that represents a bucket in an external object store.
A Container is a filesystem abstraction that can create files or other containers.
File represents a storage File.
FS is a filesystem for creating or reading files and containers.
RecordingStorage can be used to create an FS usable for session recording.
TempFile is a temporary File.
Writer is an interface that extends the io.Writer interface with an additional WriteAndClose method.
# Type aliases
AccessMode is use to determine the access mode a file is opened with.
Option is a storage option.
SyncMode is used to determine how a file is synced when closed.