encoding

package

Go to main page

Versions in this module

v1

v1.5.2

Apr 27, 2025

v1.5.1

Apr 16, 2025

Changes in this version

+ var DISABLE_ALT_URI = os.Getenv("NDN_NAME_ALT_URI") == "0"

v1.5.0

Feb 15, 2025

Changes in this version

+ const VersionImmutable

+ const VersionUnixMicro

type Component

+ func ComponentFromTlvStr(s string) (Component, error)

+ func NewGenericBytesComponent(val []byte) Component

+ func NewGenericComponent(val string) Component

+ func NewKeywordComponent(val string) Component

+ func (c Component) IsByteOffset() bool

+ func (c Component) IsGeneric(text string) bool

+ func (c Component) IsKeyword(keyword string) bool

+ func (c Component) IsSegment() bool

+ func (c Component) IsSequenceNum() bool

+ func (c Component) IsTimestamp() bool

+ func (c Component) IsVersion() bool

+ func (c Component) TlvStr() string

type Name

+ func NameFromTlvStr(s string) (Name, error)

+ func (n Name) At(i int) Component

+ func (n Name) BytesInner() []byte

+ func (n Name) Prefix(i int) Name

+ func (n Name) TlvStr() string

+ func (n Name) WithVersion(v uint64) Name

+ type WireView struct

+ func NewBufferView(buf Buffer) WireView

+ func NewWireView(wire Wire) WireView

+ func (r *WireView) CopyN(w io.Writer, size int) (int, error)

+ func (r *WireView) Delegate(size int) WireView

+ func (r *WireView) IsEOF() bool

+ func (r *WireView) Length() int

+ func (r *WireView) Pos() int

+ func (r *WireView) Range(start, end int) Wire

+ func (r *WireView) ReadBuf(size int) ([]byte, error)

+ func (r *WireView) ReadByte() (byte, error)

+ func (r *WireView) ReadComponent() (Component, error)

+ func (r *WireView) ReadFull(cpy []byte) (int, error)

+ func (r *WireView) ReadName() (Name, error)

+ func (r *WireView) ReadTLNum() (val TLNum, err error)

+ func (r *WireView) ReadWire(size int) (Wire, error)

+ func (r *WireView) Skip(n int) error

+ func (r *WireView) SkipGetSegCount(n int) (int, error)

+ func (r WireView) Debug() []byte

v1.4.3

Jan 25, 2025

Changes in this version

+ var HEX_LOWER = []rune("0123456789abcdef")

+ var HEX_UPPER = []rune("0123456789ABCDEF")

+ var LOCALHOP = NewStringComponent(TypeGenericNameComponent, "localhop")

+ var LOCALHOST = NewStringComponent(TypeGenericNameComponent, "localhost")

type Component

+ func (c Component) Append(rest ...Component) Name

+ func (c Component) WriteTo(sb *strings.Builder) int

type Name

+ func (n Name) Append(rest ...Component) Name

v1.4.2

Jan 3, 2025

v1.4.1

Dec 24, 2024

v1.4.0

Dec 24, 2024

Changes in this version

+ const DigestShaNameConvention

+ const ParamShaNameConvention

+ var ErrBufferOverflow = errors.New("buffer overflow when parsing. One of the TLV Length is wrong")

+ var ErrIncorrectDigest = errors.New("the sha256 digest is missing or incorrect")

+ func IsAlphabet(r rune) bool

+ type Buffer []byte

+ func ShrinkLength(buf Buffer, shrink int) Buffer

+ type BufferReader struct

+ func NewBufferReader(buf Buffer) *BufferReader

+ func (r *BufferReader) Delegate(l int) ParseReader

+ func (r *BufferReader) Length() int

+ func (r *BufferReader) Pos() int

+ func (r *BufferReader) Range(start, end int) Wire

+ func (r *BufferReader) Read(b []byte) (int, error)

+ func (r *BufferReader) ReadBuf(l int) (Buffer, error)

+ func (r *BufferReader) ReadByte() (byte, error)

+ func (r *BufferReader) ReadWire(l int) (Wire, error)

+ func (r *BufferReader) Seek(offset int64, whence int) (int64, error)

+ func (r *BufferReader) Skip(n int) error

+ func (r *BufferReader) UnreadByte() error

+ type Component struct

+ Typ TLNum

+ Val []byte

+ func ComponentFromBytes(buf []byte) (Component, error)

+ func ComponentFromStr(s string) (Component, error)

+ func NewByteOffsetComponent(off uint64) Component

+ func NewBytesComponent(typ TLNum, val []byte) Component

+ func NewNumberComponent(typ TLNum, val uint64) Component

+ func NewSegmentComponent(seg uint64) Component

+ func NewSequenceNumComponent(seq uint64) Component

+ func NewStringComponent(typ TLNum, val string) Component

+ func NewTimestampComponent(t uint64) Component

+ func NewVersionComponent(v uint64) Component

+ func ParseComponent(buf Buffer) (Component, int)

+ func ReadComponent(r ParseReader) (Component, error)

+ func (Component) Match(value Component, m Matching)

+ func (c Component) Bytes() []byte

+ func (c Component) CanonicalString() string

+ func (c Component) Clone() Component

+ func (c Component) Compare(rhs ComponentPattern) int

+ func (c Component) ComponentPatternTrait() ComponentPattern

+ func (c Component) EncodeInto(buf Buffer) int

+ func (c Component) EncodingLength() int

+ func (c Component) Equal(rhs ComponentPattern) bool

+ func (c Component) FromMatching(m Matching) (*Component, error)

+ func (c Component) Hash() uint64

+ func (c Component) HashInto(h hash.Hash)

+ func (c Component) IsMatch(value Component) bool

+ func (c Component) Length() TLNum

+ func (c Component) NumberVal() uint64

+ func (c Component) String() string

+ type ComponentPattern interface

+ CanonicalString func() string

+ Compare func(ComponentPattern) int

+ ComponentPatternTrait func() ComponentPattern

+ Equal func(ComponentPattern) bool

+ FromMatching func(m Matching) (*Component, error)

+ IsMatch func(value Component) bool

+ Match func(value Component, m Matching)

+ String func() string

+ func ComponentPatternFromStr(s string) (ComponentPattern, error)

+ type ErrFailToParse struct

+ Err error

+ TypeNum TLNum

+ func (e ErrFailToParse) Error() string

+ func (e ErrFailToParse) Unwrap() error

+ type ErrFormat struct

+ Msg string

+ func (e ErrFormat) Error() string

+ type ErrIncompatibleType struct

+ Name string

+ TypeNum TLNum

+ ValType string

+ Value any

+ func (e ErrIncompatibleType) Error() string

+ type ErrNotFound struct

+ Key string

+ func (e ErrNotFound) Error() string

+ type ErrSkipRequired struct

+ Name string

+ TypeNum TLNum

+ func (e ErrSkipRequired) Error() string

+ type ErrUnexpected struct

+ Err error

+ func (e ErrUnexpected) Error() string

+ func (e ErrUnexpected) Unwrap() error

+ type ErrUnrecognizedField struct

+ TypeNum TLNum

+ func (e ErrUnrecognizedField) Error() string

+ type Matching map[string][]byte

+ type Name []Component

+ func NameFromBytes(buf []byte) (Name, error)

+ func NameFromStr(s string) (Name, error)

+ func ReadName(r ParseReader) (Name, error)

+ func (n Name) Bytes() []byte

+ func (n Name) Clone() Name

+ func (n Name) Compare(rhs Name) int

+ func (n Name) EncodeInto(buf Buffer) int

+ func (n Name) EncodingLength() int

+ func (n Name) Equal(rhs Name) bool

+ func (n Name) Hash() uint64

+ func (n Name) IsPrefix(rhs Name) bool

+ func (n Name) PrefixHash() []uint64

+ func (n Name) String() string

+ func (n Name) ToFullName(rawData Wire) Name

+ type NamePattern []ComponentPattern

+ func NamePatternFromStr(s string) (NamePattern, error)

+ func (n NamePattern) Compare(rhs NamePattern) int

+ func (n NamePattern) Equal(rhs NamePattern) bool

+ func (n NamePattern) FromMatching(m Matching) (Name, error)

+ func (n NamePattern) IsPrefix(rhs NamePattern) bool

+ func (n NamePattern) Match(name Name, m Matching)

+ func (n NamePattern) String() string

+ type Nat uint64

+ func ParseNat(buf Buffer) (val Nat, pos int, err error)

+ func (v Nat) Bytes() []byte

+ func (v Nat) EncodeInto(buf Buffer) int

+ func (v Nat) EncodingLength() int

+ type ParseReader interface

+ Delegate func(l int) ParseReader

+ Length func() int

+ Pos func() int

+ Range func(start, end int) Wire

+ ReadBuf func(l int) (Buffer, error)

+ ReadWire func(l int) (Wire, error)

+ Skip func(n int) error

+ type Pattern struct

+ Tag string

+ Typ TLNum

+ func (p Pattern) CanonicalString() string

+ func (p Pattern) Compare(rhs ComponentPattern) int

+ func (p Pattern) ComponentPatternTrait() ComponentPattern

+ func (p Pattern) Equal(rhs ComponentPattern) bool

+ func (p Pattern) FromMatching(m Matching) (*Component, error)

+ func (p Pattern) IsMatch(value Component) bool

+ func (p Pattern) Match(value Component, m Matching)

+ func (p Pattern) String() string

+ type PlaceHolder struct

+ type TLNum uint64

+ const TypeByteOffsetNameComponent

+ const TypeGenericNameComponent

+ const TypeImplicitSha256DigestComponent

+ const TypeInvalidComponent

+ const TypeKeywordNameComponent

+ const TypeName

+ const TypeParametersSha256DigestComponent

+ const TypeSegmentNameComponent

+ const TypeSequenceNumNameComponent

+ const TypeTimestampNameComponent

+ const TypeVersionNameComponent

+ func ParseTLNum(buf Buffer) (val TLNum, pos int)

+ func ReadTLNum(r io.ByteReader) (val TLNum, err error)

+ func (v TLNum) EncodeInto(buf Buffer) int

+ func (v TLNum) EncodingLength() int

+ type Wire []Buffer

+ func (w Wire) Join() []byte

+ func (w Wire) Length() uint64

+ type WireReader struct

+ func NewWireReader(w Wire) *WireReader

+ func (r *WireReader) Delegate(l int) ParseReader

+ func (r *WireReader) Length() int

+ func (r *WireReader) Pos() int

+ func (r *WireReader) Range(start, end int) Wire

+ func (r *WireReader) Read(b []byte) (int, error)

+ func (r *WireReader) ReadBuf(l int) (Buffer, error)

+ func (r *WireReader) ReadByte() (byte, error)

+ func (r *WireReader) ReadWire(l int) (Wire, error)

+ func (r *WireReader) Skip(n int) error

+ func (r *WireReader) UnreadByte() error

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