io

Documentation

Overview

Package io implements the IO domain. Input/Output operations for streams produced by DevTools.

Index

• func NewClient(conn *rpcc.Conn) *domainClient
• type CloseArgs
  • func NewCloseArgs(handle StreamHandle) *CloseArgs
• type ReadArgs
  • func NewReadArgs(handle StreamHandle) *ReadArgs
  • func (a *ReadArgs) SetOffset(offset int) *ReadArgs
  • func (a *ReadArgs) SetSize(size int) *ReadArgs
• type ReadReply
• type StreamHandle

Functions

func NewClient

func NewClient(conn *rpcc.Conn) *domainClient

NewClient returns a client for the IO domain with the connection set to conn.

Types

type CloseArgs

type CloseArgs struct {
	Handle StreamHandle `json:"handle"` // Handle of the stream to close.
}

CloseArgs represents the arguments for Close in the IO domain.

func NewCloseArgs

func NewCloseArgs(handle StreamHandle) *CloseArgs

NewCloseArgs initializes CloseArgs with the required arguments.

type ReadArgs

type ReadArgs struct {
	Handle StreamHandle `json:"handle"`           // Handle of the stream to read.
	Offset *int         `json:"offset,omitempty"` // Seek to the specified offset before reading (if not specificed, proceed with offset following the last read).
	Size   *int         `json:"size,omitempty"`   // Maximum number of bytes to read (left upon the agent discretion if not specified).
}

ReadArgs represents the arguments for Read in the IO domain.

func NewReadArgs

func NewReadArgs(handle StreamHandle) *ReadArgs

NewReadArgs initializes ReadArgs with the required arguments.

func (*ReadArgs) SetOffset

func (a *ReadArgs) SetOffset(offset int) *ReadArgs

SetOffset sets the Offset optional argument. Seek to the specified offset before reading (if not specificed, proceed with offset following the last read).

func (*ReadArgs) SetSize

func (a *ReadArgs) SetSize(size int) *ReadArgs

SetSize sets the Size optional argument. Maximum number of bytes to read (left upon the agent discretion if not specified).

type ReadReply

type ReadReply struct {
	Data string `json:"data"` // Data that were read.
	EOF  bool   `json:"eof"`  // Set if the end-of-file condition occurred while reading.
}

ReadReply represents the return values for Read in the IO domain.

type StreamHandle

type StreamHandle string

StreamHandle