netiputil

package

v0.71.1 Latest Latest Go to latest Published: May 15, 2026 License: BSD-3-Clause Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/netbirdio/netbird

Links

Open Source Insights

Documentation ¶

Overview ¶

Package netiputil provides compact binary encoding for IP prefixes used in the management proto wire format.

Format: [IP bytes][1 byte prefix_len]

IPv4: 5 bytes total (4 IP + 1 prefix_len, 0-32)
IPv6: 17 bytes total (16 IP + 1 prefix_len, 0-128)

Address family is determined by length: 5 = v4, 17 = v6.

Index ¶

func DecodeAddr(b []byte) (netip.Addr, error)
func DecodePrefix(b []byte) (netip.Prefix, error)
func EncodeAddr(a netip.Addr) []byte
func EncodePrefix(p netip.Prefix) ([]byte, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DecodeAddr ¶

func DecodeAddr(b []byte) (netip.Addr, error)

DecodeAddr decodes compact prefix bytes and returns only the address, discarding the prefix length. Useful when the prefix length is implied (e.g. peer overlay IPs are always /32 or /128).

func DecodePrefix ¶

func DecodePrefix(b []byte) (netip.Prefix, error)

DecodePrefix decodes compact bytes into a netip.Prefix.

func EncodeAddr ¶

func EncodeAddr(a netip.Addr) []byte

EncodeAddr encodes a netip.Addr into compact prefix bytes with a host prefix length (/32 for v4, /128 for v6). The address is always unmapped before encoding.

func EncodePrefix ¶

func EncodePrefix(p netip.Prefix) ([]byte, error)

EncodePrefix encodes a netip.Prefix into compact bytes. The address is always unmapped before encoding.

Types ¶

This section is empty.

Source Files ¶

View all Source files

compact.go

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