commit 775b6b199cb69a5e8f0c7fb1c06a23c7f1bfd03e parent 00facecc0b5820f979b28783c003c7a2e841f9cb Author: Ajay R <ar324@protonmail.com> Date: Mon, 16 May 2022 06:14:13 +0000 encoding::hex: add README Diffstat:
| A | encoding/hex/README | | | 16 | ++++++++++++++++ |
1 file changed, 16 insertions(+), 0 deletions(-)
diff --git a/encoding/hex/README b/encoding/hex/README @@ -0,0 +1,15 @@ +This module implements hexadecimal encoding and decoding. + +A stream-based encoding and decoding interface is available via [[newencoder]] +and [[newdecoder]], which transparently encode or decode bytes to or from +hexadecimal representation when writing to or reading from an underlying I/O +handle. + +Convenience functions for encoding a byte slice into a hexadecimal string or +decoding from a string into a byte slice are also available; see [[encodestr]] +and [[decodestr]]. These functions dynamically allocate their return values; use +the stream interface if you require static allocation. + +Note that writes are always encoded as lowercase hexidecimal characters, but the +functions in this module can decode both upper- and lower-case hexidecimal +characters. +\ No newline at end of file