package core:encoding/hex
Source

⌘K
Ctrl+K
or
/

    Overview

    Encoding and decoding of hex-encoded binary, e.g. 0x23 -> #.

    Index

    Types (0)

    This section is empty.

    Constants (0)

    This section is empty.

    Variables (0)

    This section is empty.

    Procedure Groups (0)

    This section is empty.

    Types

    This section is empty.

    Constants

    This section is empty.

    Variables

    This section is empty.

    Procedures

    decode ¶
    Source · hex.odin:106

    decode :: proc(
	src:       []u8, 
	allocator := context.allocator, 
	loc := #caller_location, 
) -> (dst: []u8, ok: bool) {…}
     

    Decodes a hex sequence into a byte slice

    Allocates Using Provided Allocator

    Inputs:

    • src The []byte to be hex-decoded
    • allocator (default: context.allocator)
    • loc The caller location for debugging purposes (default: #caller_location)

    Returns:

    • dst The hex sequence decoded into bytes
    • ok A bool, true if decoding succeeded, false otherwise

    decode_into_buffer ¶
    Source · hex.odin:152

    decode_into_buffer :: proc(src: []u8, buf: []u8) -> (dst: []u8, ok: bool) #optional_ok {…}
     

    Decodes a hex sequence into a byte slice

    Inputs:

    • src The []byte to be hex-decoded
    • buf A buffer large enough to hold the decoded sequence

    Returns:

    • dst The hex sequence decoded into bytes
    • ok A bool, true if decoding succeeded, false otherwise

    decode_sequence ¶
    Source · hex.odin:185

    decode_sequence :: proc(str: string) -> (res: u8, ok: bool) {…}
     

    Decodes the first byte in a hex sequence to a byte

    Inputs:

    • str A hex-encoded string, e.g. "0x23"

    Returns:

    • res The decoded byte, e.g. '#'
    • ok A bool, true if decoding succeeded, false otherwise

    encode ¶
    Source · hex.odin:22

    encode :: proc(
	src:       []u8, 
	allocator := context.allocator, 
	loc := #caller_location, 
) -> (res: []u8, err: runtime.Allocator_Error) #optional_ok {…}
     

    Encodes a byte slice into a lowercase hex sequence

    Allocates Using Provided Allocator

    Inputs:

    • src The []byte to be hex-encoded
    • allocator (default: context.allocator)
    • loc The caller location for debugging purposes (default: #caller_location)

    Returns:

    • res The hex-encoded result
    • err An optional allocator error if one occured, .None otherwise

    encode_into_writer ¶
    Source · hex.odin:43

    encode_into_writer :: proc(dst: io.Stream, src: []u8) -> (err: io.Error) {…}
     

    Encodes a byte slice as a lowercase hex sequence into an io.Writer

    Inputs:

    • dst The io.Writer to encode into
    • src The []byte to be hex-encoded

    Returns:

    • err An io.Error if one occured, .None otherwise

    encode_upper ¶
    Source · hex.odin:64

    encode_upper :: proc(
	src:       []u8, 
	allocator := context.allocator, 
	loc := #caller_location, 
) -> (res: []u8, err: runtime.Allocator_Error) #optional_ok {…}
     

    Encodes a byte slice into an uppercase hex sequence

    Allocates Using Provided Allocator

    Inputs:

    • src The []byte to be hex-encoded
    • allocator (default: context.allocator)
    • loc The caller location for debugging purposes (default: #caller_location)

    Returns:

    • res The hex-encoded result
    • err An optional allocator error if one occured, .None otherwise

    encode_upper_into_writer ¶
    Source · hex.odin:85

    encode_upper_into_writer :: proc(dst: io.Stream, src: []u8) -> (err: io.Error) {…}
     

    Encodes a byte slice as an uppercase hex sequence into an io.Writer

    Inputs:

    • dst The io.Writer to encode into
    • src The []byte to be hex-encoded

    Returns:

    • err An io.Error if one occured, .None otherwise

    Procedure Groups

    This section is empty.

    Source Files

    Generation Information

    Generated with odin version dev-2026-10 (vendor "odin") Windows_amd64 @ 2026-10-10 00:25:51.511820200 +0000 UTC