ReadRequest

@Serializable
data class ReadRequest(val handle: StreamHandle, val offset: Int? = null, val size: Int? = null)

Request object containing input parameters for the IODomain.read command.

Constructors

Link copied to clipboard
constructor(handle: StreamHandle, offset: Int? = null, size: Int? = null)

Types

Link copied to clipboard
class Builder(val handle: StreamHandle)

A builder for ReadRequest, which allows setting the optional parameters of the IODomain.read command via a lambda.

Properties

Link copied to clipboard

Handle of the stream to read.

Link copied to clipboard
val offset: Int? = null

Seek to the specified offset before reading (if not specified, proceed with offset following the last read). Some types of streams may only support sequential reads.

Link copied to clipboard
val size: Int? = null

Maximum number of bytes to read (left upon the agent discretion if not specified).