tlv

package module

v0.0.0-...-49dca93 Latest Latest Go to latest Published: Mar 5, 2020 License: MIT Imports: 10 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/NDNLink/tlv

Links

Open Source Insights

README ¶

tlv

NDNLink's TLV packet encoder/decoder

Documentation ¶

Overview ¶

Package tlv implements Type-Length-Value (TLV) Encoding.

See http://named-data.net/doc/ndn-tlv/tlv.html.

Index ¶

Constants
Variables
func CacheType(v interface{}) error
func Copy(dst ReadFrom, src WriteTo) error
func Hash(f func() hash.Hash, v interface{}) ([]byte, error)
func Marshal(v interface{}, t uint64) ([]byte, error)
func Unmarshal(b []byte, v interface{}, t uint64) error
type ReadFrom
type Reader
- func NewReader(r io.Reader) Reader
type WriteTo
type Writer
- func NewWriter(w io.Writer) Writer

Constants ¶

View Source

const (
	// MaxSize is the upper limit for tlv buffers.
	// 1. One "common" size of Ethernet jumbo packets is 9000 octets
	// 2. It is generally sufficient to carry an 8192 byte payload in a content object
	// 3. 8800 bytes was a message size limit in ONC-RPC over UDP
	// 4. Some OSs have a limited default UDP packet size (MacOS: net.inet.udp.maxdgram: 9216) and/or a limited space for receive buffers (MacOS: net.inet.udp.recvspace: 42080)
	// 5. When a ContentObject is signed it is not known whether the transmission path will be UDP / TCP / ..
	MaxSize = 8800
)

Variables ¶

View Source

var (
	ErrPacketTooLarge = errors.New("exceed max size")
	ErrNotSupported   = errors.New("feature not supported")
	ErrUnexpectedType = errors.New("type not match")
	ErrInvalidPtr     = errors.New("invalid pointer")
)

Errors introduced by encoding and decoding.

View Source

var (
	ErrMissingType = errors.New("type not specified")
)

Errors introduced by parsing struct tags.

Functions ¶

func CacheType ¶

func CacheType(v interface{}) error

CacheType caches struct tags to prevent allocation on common types.

func Copy ¶

func Copy(dst ReadFrom, src WriteTo) error

Copy copies from src to dst. If src and dst have the same type, it will perform direct copying with reflection. Otherwise copying will happen with tlv representation.

func Hash ¶

func Hash(f func() hash.Hash, v interface{}) ([]byte, error)

Hash returns the digest of tlv-encoded data.

See Marshal.

'*' after type number indicates this tlv is signature, and should be omitted in digest calculation.

func Marshal ¶

func Marshal(v interface{}, t uint64) ([]byte, error)

Marshal returns the tlv encoding of v.

The "tlv" struct tag specifies tlv type number. '?' after type number indicates that this tlv should be omitted if the value is empty.

func Unmarshal ¶

func Unmarshal(b []byte, v interface{}, t uint64) error

Unmarshal parses the tlv-encoded data and stores the result in the value pointed to by v.

Types ¶

type ReadFrom ¶

type ReadFrom interface {
	ReadFrom(Reader) error
}

ReadFrom includes its type number, and can be directly decoded with Reader.

type Reader ¶

type Reader interface {
	// Peek returns the tlv type without advancing.
	//
	// If the buffer is invalid, it will be filled with the next tlv block.
	Peek() uint64
	// Read reads current tlv block into v.
	//
	// If the buffer is invalid, it will be filled with the next tlv block.
	Read(interface{}, uint64) error
}

Reader decodes tlv-encoded data.

func NewReader ¶

func NewReader(r io.Reader) Reader

NewReader creates a new buffered Reader.

type WriteTo ¶

type WriteTo interface {
	WriteTo(Writer) error
}

WriteTo includes its type number, and can be directly encoded with Writer.

type Writer ¶

type Writer interface {
	Write(interface{}, uint64) error
}

Writer encodes data in tlv.

func NewWriter ¶

func NewWriter(w io.Writer) Writer

NewWriter creates a new buffered Writer.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL