package proto

Import Path
	github.com/redis/go-redis/v9/internal/proto (on go.dev)

Dependency Relation
	imports 12 packages, and imported by 2 packages

Involved Source Files

	    reader.go
	    scan.go
	    writer.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Reader (struct)

		Methods (total 18)
			(*Reader) Buffered() int
			(*Reader) Discard(line []byte) (err error)
				Discard the data represented by line.

			(*Reader) DiscardNext() error
				DiscardNext read and discard the data represented by the next line.

			(*Reader) Peek(n int) ([]byte, error)
			(*Reader) PeekReplyType() (byte, error)
				PeekReplyType returns the data type of the next response without advancing the Reader,
				and discard the attribute type.

			(*Reader) ReadArrayLen() (int, error)
				ReadArrayLen Read and return the length of the array.

			(*Reader) ReadBool() (bool, error)
			(*Reader) ReadFixedArrayLen(fixedLen int) error
				ReadFixedArrayLen read fixed array length.

			(*Reader) ReadFixedMapLen(fixedLen int) error
				ReadFixedMapLen reads fixed map length.

			(*Reader) ReadFloat() (float64, error)
			(*Reader) ReadInt() (int64, error)
			(*Reader) ReadLine() ([]byte, error)
				ReadLine Return a valid reply, it will check the protocol or redis error,
				and discard the attribute type.

			(*Reader) ReadMapLen() (int, error)
				ReadMapLen reads the length of the map type.
				If responding to the array type (RespArray/RespSet/RespPush),
				it must be a multiple of 2 and return n/2.
				Other types will return an error.

			(*Reader) ReadReply() (interface{}, error)
			(*Reader) ReadSlice() ([]interface{}, error)
			(*Reader) ReadString() (string, error)
			(*Reader) ReadUint() (uint64, error)
			(*Reader) Reset(rd io.Reader)
		As Outputs Of (at least one exported)
			func NewReader(rd io.Reader) *Reader

	 type RedisError string (basic type)

		Methods (total 2)
			( RedisError) Error() string
			( RedisError) RedisError()
		Implements (at least 2)
			 RedisError : github.com/redis/go-redis/v9.Error
			 RedisError : error
		As Types Of (total 3)
			const Nil
			const github.com/redis/go-redis/v9.Nil
			const github.com/redis/go-redis/v9.TxFailedErr

	 type Writer (struct)

		Methods (total 5)
			( Writer) Write([]byte) (int, error)
			(*Writer) WriteArg(v interface{}) error
			(*Writer) WriteArgs(args []interface{}) error
			( Writer) WriteByte(c byte) error
			( Writer) WriteString(string) (int, error)
		Implements (at least 7)
			 Writer : github.com/miekg/dns.Writer
			 Writer : github.com/quic-go/quic-go/quicvarint.Writer
			 Writer : gorm.io/gorm/clause.Writer
			 Writer : internal/bisect.Writer
			 Writer : io.ByteWriter
			 Writer : io.StringWriter
			 Writer : io.Writer
		As Outputs Of (at least one exported)
			func NewWriter(wr writer) *Writer


Package-Level Functions (total 6)

	 func IsNilReply(line []byte) bool
		IsNilReply detects redis.Nil of RESP2.

	 func NewReader(rd io.Reader) *Reader
	 func NewWriter(wr writer) *Writer
	 func ParseErrorReply(line []byte) error
	 func Scan(b []byte, v interface{}) error
		Scan parses bytes `b` to `v` with appropriate type.

	 func ScanSlice(data []string, slice interface{}) error
Package-Level Constants (total 16)

	const Nil RedisError = "redis: nil" // nolint:errname
	const RespArray = 42 // *<len>\r\n... (same as resp2)
		redis resp protocol data type.

	const RespAttr = 124 // |<len>\r\n(key)\r\n(value)\r\n... + command reply
		redis resp protocol data type.

	const RespBigInt = 40 // (<big number>\r\n
		redis resp protocol data type.

	const RespBlobError = 33 // !<length>\r\n<bytes>\r\n
		redis resp protocol data type.

	const RespBool = 35 // true: #t\r\n false: #f\r\n
		redis resp protocol data type.

	const RespError = 45 // -<string>\r\n
		redis resp protocol data type.

	const RespFloat = 44 // ,<floating-point-number>\r\n (golang float)
		redis resp protocol data type.

	const RespInt = 58 // :<number>\r\n
		redis resp protocol data type.

	const RespMap = 37 // %<len>\r\n(key)\r\n(value)\r\n... (golang map)
		redis resp protocol data type.

	const RespNil = 95 // _\r\n
		redis resp protocol data type.

	const RespPush = 62 // ><len>\r\n... (same as Array)
		redis resp protocol data type.

	const RespSet = 126 // ~<len>\r\n... (same as Array)
		redis resp protocol data type.

	const RespStatus = 43 // +<string>\r\n
		redis resp protocol data type.

	const RespString = 36 // $<length>\r\n<bytes>\r\n
		redis resp protocol data type.

	const RespVerbatim = 61 // =<length>\r\nFORMAT:<bytes>\r\n
		redis resp protocol data type.

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.