pktline

Documentation

Index

• Constants
• func Data(pkt []byte) []byte
• func IsFlush(pkt []byte) bool
• func NewScanner(r io.Reader, buf []byte) *bufio.Scanner
• func PktDone() []byte
• func PktFlush() []byte
• func WriteDelim(w io.Writer) error
• func WriteFlush(w io.Writer) error
• func WriteString(w io.Writer, str string) (int, error)

Constants

const (
	// MaxPktSize is the maximum size of content of a Git pktline side-band-64k
	// packet, excluding size of length and band number
	// https://gitlab.com/gitlab-org/git/-/blob/v2.30.0/pkt-line.h#L216
	MaxPktSize = 65520
)

Functions

func Data

func Data(pkt []byte) []byte

Data returns the packet pkt without its length header. The length header is not validated. Returns an empty slice when pkt is a magic packet such as '0000'.

func IsFlush

func IsFlush(pkt []byte) bool

IsFlush detects the special flush packet '0000'

func NewScanner

func NewScanner(r io.Reader, buf []byte) *bufio.Scanner

NewScanner returns a bufio.Scanner that splits on Git pktline boundaries Buf must be at least MaxPktSize large.

func PktDone

func PktDone() []byte

PktDone returns the bytes for a "done" packet.

func PktFlush

func PktFlush() []byte

PktFlush returns the bytes for a "flush" packet.

func WriteDelim

func WriteDelim(w io.Writer) error

WriteDelim writes a pkt delim packet.

func WriteFlush

func WriteFlush(w io.Writer) error

WriteFlush writes a pkt flush packet.

func WriteString

func WriteString(w io.Writer, str string) (int, error)

WriteString writes a string with pkt-line framing