Overview

Package hex implements hexadecimal encoding and decoding.

Index

• func Decode(dst, src []byte) (int, error)
• func DecodedLen(x int) int
• func Dumper(w io.Writer) io.WriteCloser
• func EncodeToString(src []byte) string
• func NewDecoder(r io.Reader) io.Reader
• type InvalidByteError

• Decode
• Dump
• Encode

hex.go

Variables

ErrLength reports an attempt to decode an odd-length input using Decode or
DecodeString. The stream-based Decoder returns io.ErrUnexpectedEOF instead of
ErrLength.

func
¶

func Decode(dst, src []) (int, )

Decode decodes src into DecodedLen(len(src)) bytes, returning the actual number
of bytes written to dst.

Decode expects that src contain only hexadecimal characters and that src should
have an even length. If the input is malformed, Decode returns the number of
bytes decoded before the error.

Example:

src := []byte("48656c6c6f20476f7068657221")
dst := make([]byte, hex.DecodedLen(len(src)))
n, err := hex.Decode(dst, src)
if err != nil {
    log.Fatal(err)
}
// Output:
// Hello Gopher!

func DecodeString(s ) ([]byte, )

DecodeString returns the bytes represented by the hexadecimal string s.

DecodeString expects that src contain only hexadecimal characters and that src
should have an even length. If the input is malformed, DecodeString returns a
string containing the bytes decoded before the error.

Example:

const s = "48656c6c6f20476f7068657221"
decoded, err := hex.DecodeString(s)
if err != nil {
    log.Fatal(err)
}
fmt.Printf("%s\n", decoded)
// Output:
// Hello Gopher!

func
¶

func DecodedLen(x ) int

DecodedLen returns the length of a decoding of x source bytes. Specifically, it
returns x / 2.

func
¶

Dump returns a string that contains a hex dump of the given data. The format of
the hex dump matches the output of on the command line.

Example:

content := []byte("Go is an open source programming language.")
fmt.Printf("%s", hex.Dump(content))
// Output:
// 00000000  47 6f 20 69 73 20 61 6e  20 6f 70 65 6e 20 73 6f  |Go is an open so|
// 00000010  75 72 63 65 20 70 72 6f  67 72 61 6d 6d 69 6e 67  |urce programming|
// 00000020  20 6c 61 6e 67 75 61 67  65 2e                    | language.|

func Dumper

func Dumper(w io.) io.

Dumper returns a WriteCloser that writes a hex dump of all written data to w.
The format of the dump matches the output of hexdump -C on the command line.

Example:

lines := []string{
    "Go is an open source programming language.",
    "\n",
    "We encourage all Go users to subscribe to golang-announce.",
}
stdoutDumper := hex.Dumper(os.Stdout)
for _, line := range lines {
    stdoutDumper.Write([]byte(line))
}
// Output:
// 00000000  47 6f 20 69 73 20 61 6e  20 6f 70 65 6e 20 73 6f  |Go is an open so|
// 00000010  75 72 63 65 20 70 72 6f  67 72 61 6d 6d 69 6e 67  |urce programming|
// 00000020  20 6c 61 6e 67 75 61 67  65 2e 0a 57 65 20 65 6e  | language..We en|
// 00000030  63 6f 75 72 61 67 65 20  61 6c 6c 20 47 6f 20 75  |courage all Go u|
// 00000040  73 65 72 73 20 74 6f 20  73 75 62 73 63 72 69 62  |sers to subscrib|
// 00000050  65 20 74 6f 20 67 6f 6c  61 6e 67 2d 61 6e 6e 6f  |e to golang-anno|
// 00000060  75 6e 63 65 2e                                    |unce.|

func
¶

func Encode(dst, src []) int

Encode encodes src into EncodedLen(len(src)) bytes of dst. As a convenience, it
returns the number of bytes written to dst, but this value is always
EncodedLen(len(src)). Encode implements hexadecimal encoding.

Example:

src := []byte("Hello Gopher!")
dst := make([]byte, hex.EncodedLen(len(src)))
hex.Encode(dst, src)
fmt.Printf("%s\n", dst)
// Output:
// 48656c6c6f20476f7068657221

Example:

src := []byte("Hello")
encodedStr := hex.EncodeToString(src)
fmt.Printf("%s\n", encodedStr)
// 48656c6c6f

func
¶

func EncodedLen(n ) int

EncodedLen returns the length of an encoding of n source bytes. Specifically, it
returns n * 2.

func
¶

func NewDecoder(r .Reader) .Reader

NewDecoder returns an io.Reader that decodes hexadecimal characters from r.
NewDecoder expects that r contain only an even number of hexadecimal characters.

func
¶

NewEncoder returns an io.Writer that writes lowercase hexadecimal characters to
w.

type
¶

type InvalidByteError 

InvalidByteError values describe errors resulting from an invalid byte in a hex
string.