FileHandle

trait FileHandle[F[_]] extends FileHandlePlatform[F]

Provides the ability to read/write/lock/inspect a file in the effect F.

Companion
object
trait FileHandlePlatform[F]
class Object
trait Matchable
class Any

Value members

Abstract methods

def force(metaData: Boolean): F[Unit]

Force any updates for the underlying file to storage.

Force any updates for the underlying file to storage.

Value Params
metaData

If true, also attempts to force file metadata updates to storage.

def read(numBytes: Int, offset: Long): F[Option[Chunk[Byte]]]

Read the specified number of bytes at a particular offset.

Read the specified number of bytes at a particular offset.

Value Params
numBytes

the number of bytes to read.

offset

the offset from the start of the file.

Returns

a number of bytes from the file (at most, numBytes in size).

def size: F[Long]

Report the current size of the file.

Report the current size of the file.

Returns

the size of the file.

def truncate(size: Long): F[Unit]

Truncate the underlying file to the specified size.

Truncate the underlying file to the specified size.

Value Params
size

the size of the file after truncation.

def write(bytes: Chunk[Byte], offset: Long): F[Int]

Write the specified bytes at a particular offset.

Write the specified bytes at a particular offset.

Value Params
bytes

the bytes to write to the FileHandle.

offset

the offset at which to write the bytes.

Returns

the number of bytes written.