protocol

package

v1.15.0 Latest Latest Go to latest Published: Apr 21, 2026 License: AGPL-3.0 Imports: 3 Imported by: 0

Details

View Source

const (
	CompressedFlag byte = 0x01 // Message is compressed
	EndStreamFlag  byte = 0x02 // Final message in stream
)

Envelope protocol flags

This section is empty.

func CreateEnvelope(flags byte, data []byte) []byte

CreateEnvelope creates an envelope with the given flags and data.

func WriteEnvelope(w io.Writer, flags byte, data []byte) error

WriteEnvelope writes an envelope to an io.Writer.

type Envelope struct {
	Flags  byte
	Length uint32
	Data   []byte
}

Envelope represents a ConnectRPC envelope message with flags and data. Format: [1 byte flags][4 bytes length][N bytes data]

func ParseEnvelope(data []byte) (*Envelope, []byte, error)

ParseEnvelope reads an envelope from the provided data. Returns the parsed envelope and any remaining unconsumed data.

func ReadEnvelope(r io.Reader) (*Envelope, error)

ReadEnvelope reads a single envelope from an io.Reader.

func (e *Envelope) IsCompressed() bool

IsCompressed checks if the envelope has the Compressed flag set.

func (e *Envelope) IsEndStream() bool

IsEndStream checks if the envelope has the EndStream flag set.