# README
Frame Streams implementation in Go
https://github.com/farsightsec/golang-framestream
Frame Streams is a lightweight, binary-clean protocol that allows for the transport of arbitrarily encoded data payload sequences with minimal framing overhead.
This package provides a pure Golang implementation. The Frame Streams implementation in C is at https://github.com/farsightsec/fstrm/.
The example framestream_dump program reads a Frame Streams formatted input file and prints the data frames and frame byte counts.
# Packages
No description provided by the author
# Functions
NewDecoder returns a Decoder using the given io.Reader and options.
NewEncoder creates an Encoder writing to the given io.Writer with the given EncoderOptions.
NewReader creates a Frame Streams Reader reading from the given io.Reader with the given ReaderOptions.
NewWriter returns a Frame Streams Writer using the given io.Writer and options.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
A Decoder decodes Frame Streams frames read from an underlying io.Reader.
DecoderOptions specifies configuration for a framestream Decoder.
An Encoder sends data frames over a FrameStream Writer.
EncoderOptions specifies configuration for an Encoder.
Reader reads data frames from an underlying io.Reader using the Frame Streams framing protocol.
No description provided by the author
A Writer writes data frames to a Frame Streams file or connection.
No description provided by the author