package io

Import Path
	github.com/chromedp/cdproto/io (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 5 packages

Involved Source Files

	    easyjson.go
	  d io.go
		Package io provides the Chrome DevTools Protocol
		commands, types, and events for the IO domain.
		
		Input/Output operations for streams produced by DevTools.
		
		Generated by the cdproto-gen command.

	    types.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type CloseParams (struct)
		CloseParams close the stream, discard any temporary backing storage.

		Fields (only one)
			Handle StreamHandle
				// Handle of the stream to close.

		Methods (total 5)
			(*CloseParams) Do(ctx context.Context) (err error)
				Do executes IO.close against the provided context.

			( CloseParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( CloseParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*CloseParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*CloseParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*CloseParams : github.com/chromedp/chromedp.Action
			*CloseParams : github.com/chromedp/chromedp.CallAction
			*CloseParams : github.com/chromedp/chromedp.EmulateAction
			*CloseParams : github.com/chromedp/chromedp.EvaluateAction
			*CloseParams : github.com/chromedp/chromedp.KeyAction
			*CloseParams : github.com/chromedp/chromedp.MouseAction
			*CloseParams : github.com/chromedp/chromedp.NavigateAction
			*CloseParams : github.com/chromedp/chromedp.PollAction
			*CloseParams : github.com/chromedp/chromedp.QueryAction
			 CloseParams : github.com/goccy/go-json.Marshaler
			*CloseParams : github.com/goccy/go-json.Unmarshaler
			 CloseParams : github.com/mailru/easyjson.Marshaler
			*CloseParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*CloseParams : github.com/mailru/easyjson.Unmarshaler
			 CloseParams : encoding/json.Marshaler
			*CloseParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func Close(handle StreamHandle) *CloseParams

	 type ReadParams (struct)
		ReadParams read a chunk of the stream.

		Fields (total 3)
			Handle StreamHandle
				// Handle of the stream to read.

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

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

		Methods (total 7)
			(*ReadParams) Do(ctx context.Context) (data string, eof bool, err error)
				Do executes IO.read against the provided context.
				
				returns:
				
					data - Data that were read.
					eof - Set if the end-of-file condition occurred while reading.

			( ReadParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( ReadParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*ReadParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*ReadParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

			( ReadParams) WithOffset(offset int64) *ReadParams
				WithOffset seek to the specified offset before reading (if not specificed,
				proceed with offset following the last read). Some types of streams may only
				support sequential reads.

			( ReadParams) WithSize(size int64) *ReadParams
				WithSize maximum number of bytes to read (left upon the agent discretion
				if not specified).

		Implements (at least 7)
			 ReadParams : github.com/goccy/go-json.Marshaler
			*ReadParams : github.com/goccy/go-json.Unmarshaler
			 ReadParams : github.com/mailru/easyjson.Marshaler
			*ReadParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*ReadParams : github.com/mailru/easyjson.Unmarshaler
			 ReadParams : encoding/json.Marshaler
			*ReadParams : encoding/json.Unmarshaler
		As Outputs Of (at least 3)
			func Read(handle StreamHandle) *ReadParams
			func ReadParams.WithOffset(offset int64) *ReadParams
			func ReadParams.WithSize(size int64) *ReadParams

	 type ReadReturns (struct)
		ReadReturns return values.

		Fields (total 3)
			Base64encoded bool
				// Set if the data is base64-encoded

			Data string
				// Data that were read.

			EOF bool
				// Set if the end-of-file condition occurred while reading.

		Methods (total 4)
			( ReadReturns) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( ReadReturns) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*ReadReturns) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*ReadReturns) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 ReadReturns : github.com/goccy/go-json.Marshaler
			*ReadReturns : github.com/goccy/go-json.Unmarshaler
			 ReadReturns : github.com/mailru/easyjson.Marshaler
			*ReadReturns : github.com/mailru/easyjson.MarshalerUnmarshaler
			*ReadReturns : github.com/mailru/easyjson.Unmarshaler
			 ReadReturns : encoding/json.Marshaler
			*ReadReturns : encoding/json.Unmarshaler

	 type ResolveBlobParams (struct)
		ResolveBlobParams return UUID of Blob object specified by a remote object
		id.

		Fields (only one)
			ObjectID runtime.RemoteObjectID
				// Identifier of the object to release.

		Methods (total 5)
			(*ResolveBlobParams) Do(ctx context.Context) (uuid string, err error)
				Do executes IO.resolveBlob against the provided context.
				
				returns:
				
					uuid - UUID of the specified Blob.

			( ResolveBlobParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( ResolveBlobParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*ResolveBlobParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*ResolveBlobParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 ResolveBlobParams : github.com/goccy/go-json.Marshaler
			*ResolveBlobParams : github.com/goccy/go-json.Unmarshaler
			 ResolveBlobParams : github.com/mailru/easyjson.Marshaler
			*ResolveBlobParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*ResolveBlobParams : github.com/mailru/easyjson.Unmarshaler
			 ResolveBlobParams : encoding/json.Marshaler
			*ResolveBlobParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func ResolveBlob(objectID runtime.RemoteObjectID) *ResolveBlobParams

	 type ResolveBlobReturns (struct)
		ResolveBlobReturns return values.

		Fields (only one)
			UUID string
				// UUID of the specified Blob.

		Methods (total 4)
			( ResolveBlobReturns) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( ResolveBlobReturns) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*ResolveBlobReturns) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*ResolveBlobReturns) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 ResolveBlobReturns : github.com/goccy/go-json.Marshaler
			*ResolveBlobReturns : github.com/goccy/go-json.Unmarshaler
			 ResolveBlobReturns : github.com/mailru/easyjson.Marshaler
			*ResolveBlobReturns : github.com/mailru/easyjson.MarshalerUnmarshaler
			*ResolveBlobReturns : github.com/mailru/easyjson.Unmarshaler
			 ResolveBlobReturns : encoding/json.Marshaler
			*ResolveBlobReturns : encoding/json.Unmarshaler

	 type StreamHandle string (basic type)
		StreamHandle this is either obtained from another method or specified as
		blob:<uuid> where <uuid> is an UUID of a Blob.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/IO#type-StreamHandle

		Methods (only one)
			( StreamHandle) String() string
				String returns the StreamHandle as string value.

		Implements (at least 2)
			 StreamHandle : expvar.Var
			 StreamHandle : fmt.Stringer
		As Outputs Of (at least 3)
			func github.com/chromedp/cdproto/fetch.(*TakeResponseBodyAsStreamParams).Do(ctx context.Context) (stream StreamHandle, err error)
			func github.com/chromedp/cdproto/network.(*TakeResponseBodyForInterceptionAsStreamParams).Do(ctx context.Context) (stream StreamHandle, err error)
			func github.com/chromedp/cdproto/page.(*PrintToPDFParams).Do(ctx context.Context) (data []byte, stream StreamHandle, err error)
		As Inputs Of (at least 2)
			func Close(handle StreamHandle) *CloseParams
			func Read(handle StreamHandle) *ReadParams


Package-Level Functions (total 3)

	 func Close(handle StreamHandle) *CloseParams
		Close close the stream, discard any temporary backing storage.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/IO#method-close
		
		parameters:
		
			handle - Handle of the stream to close.

	 func Read(handle StreamHandle) *ReadParams
		Read read a chunk of the stream.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/IO#method-read
		
		parameters:
		
			handle - Handle of the stream to read.

	 func ResolveBlob(objectID runtime.RemoteObjectID) *ResolveBlobParams
		ResolveBlob return UUID of Blob object specified by a remote object id.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/IO#method-resolveBlob
		
		parameters:
		
			objectID - Object id of a Blob object wrapper.


Package-Level Constants (total 3)

	const CommandClose = "IO.close"
		Command names.

	const CommandRead = "IO.read"
		Command names.

	const CommandResolveBlob = "IO.resolveBlob"
		Command names.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.