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
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

framer

package module

Go to main page

Versions in this module

v0

v0.1.4

Mar 3, 2026

v0.1.3

Feb 16, 2026

v0.1.2

Dec 19, 2025

v0.1.1

Dec 19, 2025

v0.1.0

Dec 16, 2025

Changes in this version

+ var ErrInvalidArgument = errors.New("framer: invalid argument")

+ var ErrMore = iox.ErrMore

+ var ErrTooLong = errors.New("framer: message too long")

+ var ErrWouldBlock = iox.ErrWouldBlock

+ func NewPipe(opts ...Option) (reader io.Reader, writer io.Writer)

+ func NewReadWriter(r io.Reader, w io.Writer, opts ...Option) io.ReadWriter

+ func NewReader(r io.Reader, opts ...Option) io.Reader

+ func NewWriter(w io.Writer, opts ...Option) io.Writer

+ type Forwarder struct

+ func NewForwarder(dst io.Writer, src io.Reader, opts ...Option) *Forwarder

+ func (f *Forwarder) ForwardOnce() (n int, err error)

+ type Option func(*Options)

+ func WithBlock() Option

+ func WithByteOrder(order binary.ByteOrder) Option

+ func WithNonblock() Option

+ func WithProtocol(proto Protocol) Option

+ func WithReadByteOrder(order binary.ByteOrder) Option

+ func WithReadLimit(limit int) Option

+ func WithReadLocal() Option

+ func WithReadProtocol(proto Protocol) Option

+ func WithReadSCTP() Option

+ func WithReadTCP() Option

+ func WithReadUDP() Option

+ func WithReadUnix() Option

+ func WithReadUnixPacket() Option

+ func WithReadWebSocket() Option

+ func WithRetryDelay(d time.Duration) Option

+ func WithWriteByteOrder(order binary.ByteOrder) Option

+ func WithWriteLocal() Option

+ func WithWriteProtocol(proto Protocol) Option

+ func WithWriteSCTP() Option

+ func WithWriteTCP() Option

+ func WithWriteUDP() Option

+ func WithWriteUnix() Option

+ func WithWriteUnixPacket() Option

+ func WithWriteWebSocket() Option

+ type Options struct

+ ReadByteOrder binary.ByteOrder

+ ReadLimit int

+ ReadProto Protocol

+ RetryDelay time.Duration

+ WriteByteOrder binary.ByteOrder

+ WriteProto Protocol

+ type Protocol uint8

+ const BinaryStream

+ const Datagram

+ const SeqPacket

+ type ReadWriter struct

+ type Reader struct

+ func (r *Reader) Read(p []byte) (int, error)

+ func (r *Reader) WriteTo(dst io.Writer) (int64, error)

+ type Writer struct

+ func (w *Writer) ReadFrom(src io.Reader) (int64, error)

+ func (w *Writer) Write(p []byte) (int, error)