Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

protocol

package

Go to main page

Versions in this module

v1

v1.2.2

May 14, 2026

v1.2.1

May 8, 2026

v1.2.0

May 8, 2026

Changes in this version

+ const ParticleTypeBlob

+ const ParticleTypeFloat

+ const ParticleTypeInteger

+ const ParticleTypeString

+ var ErrInvalidRequest = errors.New("invalid protocol request")

+ func ExpAndChecked(exprs ...[]byte) ([]byte, error)

+ func ExpFloatBinChecked(name string) ([]byte, error)

+ func ExpIntBinChecked(name string) ([]byte, error)

+ func ExpOrChecked(exprs ...[]byte) ([]byte, error)

+ func ExpStringBinChecked(name string) ([]byte, error)

+ func ExpStringValChecked(v string) ([]byte, error)

+ func IsValidationError(err error) bool

type Operation

+ func (o *Operation) Validate() error

type Request

+ func (r *Request) MarshalChecked() ([]byte, error)

+ func (r *Request) MarshalIntoChecked(buf []byte) (int, error)

+ func (r *Request) MarshalPayloadChecked() ([]byte, error)

+ func (r *Request) Validate() error

v1.1.0

Apr 25, 2026

v1.0.0

Apr 25, 2026

v0

v0.1.0

Apr 25, 2026

Changes in this version

+ const FieldDigest

+ const FieldFilter

+ const FieldGroup

+ const FieldHeaderSize

+ const FieldKey

+ const FieldNamespace

+ const FieldSet

+ const FlagCommitMaster

+ const FlagCreateOnly

+ const FlagPreserveTTL

+ const FlagPrimaryOnly

+ const FlagReadMaster

+ const FlagReadMasterOrReplica

+ const FlagReadReplicaOnly

+ const FlagReplace

+ const FlagRespondAllOps

+ const FlagSendKey

+ const FlagWriteMerge

+ const HeaderSize

+ const MaxPayloadSize

+ const OpBatch

+ const OpBatchDelete

+ const OpBatchDeleteResp

+ const OpBatchGet

+ const OpBatchGetResp

+ const OpBatchOperate

+ const OpBatchOperateResp

+ const OpBatchPut

+ const OpBatchPutResp

+ const OpBatchResp

+ const OpCount

+ const OpCountResp

+ const OpDelete

+ const OpDeleteResp

+ const OpFlagCreateOnly

+ const OpGet

+ const OpGetMap

+ const OpGetMapResp

+ const OpGetResp

+ const OpLSHDedup

+ const OpLSHVector

+ const OpOperate

+ const OpOperateResp

+ const OpPing

+ const OpPingResp

+ const OpPut

+ const OpPutResp

+ const OpScan

+ const OpScanResp

+ const OpTypeAppend

+ const OpTypeIncr

+ const OpTypePrepend

+ const OpTypeRead

+ const OpTypeWrite

+ const OperationHeaderSize

+ const ProtoVersionLegacy

+ const ProtoVersionMultiplexed

+ const ReadPolicyMask

+ const RequestPayloadHeaderSize

+ const ResponseBinHeaderSize

+ const ResponsePayloadHeaderSize

+ const ResultFilteredOut

+ const ResultGenerationError

+ const ResultInDoubt

+ const ResultKeyExists

+ const ResultKeyNotFound

+ const ResultOK

+ const ResultOverloaded

+ const ResultPartitionUnavailable

+ const ResultServerError

+ const VersionV1

+ var Magic = [2]byte

+ var ResponseBufPool = sync.Pool

+ func AcquireOperations() *[]Operation

+ func AcquireResponseBuf() *[]byte

+ func EncodeScanResponse(nextCursor uint32, records []ScanRecord) []byte

+ func ExpAnd(exprs ...[]byte) []byte

+ func ExpEqual(left, right []byte) []byte

+ func ExpFloatBin(name string) []byte

+ func ExpFloatVal(v float64) []byte

+ func ExpGreater(left, right []byte) []byte

+ func ExpGreaterOrEqual(left, right []byte) []byte

+ func ExpIntBin(name string) []byte

+ func ExpIntVal(v int64) []byte

+ func ExpLess(left, right []byte) []byte

+ func ExpLessOrEqual(left, right []byte) []byte

+ func ExpNot(expr []byte) []byte

+ func ExpNotEqual(left, right []byte) []byte

+ func ExpOr(exprs ...[]byte) []byte

+ func ExpStringBin(name string) []byte

+ func ExpStringVal(v string) []byte

+ func HasPrimaryOnly(opCode uint8, flags uint16) bool

+ func MarshalBatchGetResults(results []BatchGetResult) []byte

+ func ReleaseOperations(ops *[]Operation)

+ func ReleaseRequest(req *Request)

+ func ReleaseResponse(resp *Response)

+ func ReleaseResponseBuf(b *[]byte)

+ type BatchGetResult struct

+ Bins []ResponseBin

+ Generation uint32

+ ResultCode uint8

+ func UnmarshalBatchGetResults(buf []byte) ([]BatchGetResult, error)

+ type BatchRecord struct

+ Flags uint16

+ Generation uint32

+ Key []byte

+ Operations []Operation

+ TTL uint32

+ type Field struct

+ Data []byte

+ Type uint8

+ func UnmarshalField(buf []byte) (Field, int, error)

+ func (f *Field) MarshalSize() int

+ func (f *Field) MarshalTo(buf []byte) int

+ type Header struct

+ Flags uint16

+ Generation uint32

+ Magic [2]byte

+ OpCode uint8

+ PartitionID uint16

+ PayloadLen uint32

+ RequestID uint32

+ Version uint8

+ func (h *Header) Marshal(buf []byte)

+ func (h *Header) Unmarshal(buf []byte) error

+ type Operation struct

+ BinName string

+ Data []byte

+ Flags uint8

+ OpType uint8

+ ParticleType uint8

+ func UnmarshalOperation(buf []byte) (Operation, int, error)

+ func (o *Operation) MarshalSize() int

+ func (o *Operation) MarshalTo(buf []byte) int

+ type Request struct

+ BatchKeys [][]byte

+ BatchRecords []BatchRecord

+ Digest [20]byte

+ FilterExpression []byte

+ Group string

+ Header Header

+ Key []byte

+ Namespace string

+ NsID uint16

+ NsResolved bool

+ Operations []Operation

+ Set string

+ SetID uint16

+ TTL uint32

+ func AcquireRequest() *Request

+ func (r *Request) Marshal() []byte

+ func (r *Request) MarshalInto(buf []byte) int

+ func (r *Request) MarshalPayload() []byte

+ func (r *Request) MarshalSize() int

+ func (r *Request) Reset()

+ func (r *Request) Unmarshal(buf []byte) error

+ func (r *Request) UnmarshalPayload(buf []byte) error

+ type Response struct

+ Bins []ResponseBin

+ Generation uint32

+ Header Header

+ ResultCode uint8

+ func AcquireResponse() *Response

+ func (r *Response) Marshal() []byte

+ func (r *Response) MarshalInto(buf []byte) int

+ func (r *Response) MarshalPayload() []byte

+ func (r *Response) MarshalPayloadInto(buf []byte) []byte

+ func (r *Response) MarshalSize() int

+ func (r *Response) Reset()

+ func (r *Response) Unmarshal(buf []byte) error

+ func (r *Response) UnmarshalPayload(buf []byte) error

+ type ResponseBin struct

+ Data []byte

+ Name string

+ ParticleType uint8

+ type ScanRecord struct

+ Bins []ResponseBin

+ Generation uint32

+ func DecodeScanResponse(data []byte) (uint32, []ScanRecord, error)