package hex

Import Path
	github.com/tmthrgd/go-hex (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	   #d hex.go
		Package hex is an efficient hexadecimal implementation for Golang.

	      hex_amd64.go
	      hex_decode_amd64.s
	      hex_encode_amd64.s
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type InvalidByteError byte (basic type)
		InvalidByteError values describe errors resulting from an invalid byte in a hex string.

		Methods (only one, which is exported)
			( InvalidByteError) Error() string
		Implements (at least one exported)
			 InvalidByteError : error


Package-Level Functions (total 18, in which 11 are exported)

	 func Decode(dst, src []byte) (int, error)
		Decode decodes src into DecodedLen(len(src)) bytes, returning the actual
		number of bytes written to dst.

		If Decode encounters invalid input, it returns an error describing the failure.

	 func DecodedLen(n int) int
		DecodedLen returns the length of a decoding of n source bytes.

	 func DecodeString(s string) ([]byte, error)
		DecodeString returns the bytes represented by the hexadecimal string s.

	 func Encode(dst, src []byte) 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 lowercase hexadecimal encoding.

	 func EncodedLen(n int) int
		EncodedLen returns the length of an encoding of n source bytes.

	 func EncodeToString(src []byte) string
		EncodeToString returns the lowercase hexadecimal encoding of src.

	 func EncodeUpper(dst, src []byte) int
		EncodeUpper 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)).
		EncodeUpper implements uppercase hexadecimal encoding.

	 func EncodeUpperToString(src []byte) string
		EncodeUpperToString returns the uppercase hexadecimal encoding of src.

	 func MustDecodeString(str string) []byte
		MustDecodeString is like DecodeString but panics if the string cannot be
		parsed. It simplifies safe initialization of global variables holding
		binary data.

	 func RawEncode(dst, src, alpha []byte) int
		RawEncode 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)).
		RawEncode implements hexadecimal encoding for a given alphabet.

	 func RawEncodeToString(src, alpha []byte) string
		RawEncodeToString returns the hexadecimal encoding of src for a given
		alphabet.

	/* 7 unexporteds ... *//* 7 unexporteds: */
	 func decodeAVX(dst *byte, src *byte, len uint64) (n uint64, ok bool)
		This function is implemented in hex_decode_amd64.s

	 func decodeGeneric(dst, src []byte) (uint64, bool)
	 func decodeSSE(dst *byte, src *byte, len uint64) (n uint64, ok bool)
		This function is implemented in hex_decode_amd64.s

	 func encodeAVX(dst *byte, src *byte, len uint64, alpha *byte)
		This function is implemented in hex_encode_amd64.s

	 func encodeGeneric(dst, src, alpha []byte)
	 func encodeSSE(dst *byte, src *byte, len uint64, alpha *byte)
		This function is implemented in hex_encode_amd64.s

	 func fromHexChar(c byte) (byte, bool)
		fromHexChar converts a hex character into its value and a success flag.


Package-Level Variables (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	  var errLength error
	  var lower []byte
	  var upper []byte

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)