Endianess and byte swapping

Collaboration diagram for Endianess and byte swapping:

Macros
#define	CT_BIG_ENDIAN   __ORDER_BIG_ENDIAN__
	the big endian byte order More...
#define	CT_LITTLE_ENDIAN   __ORDER_LITTLE_ENDIAN__
	the little endian byte order More...
#define	CT_BYTE_ORDER   __BYTE_ORDER__
	the native byte order More...

Enumerations
enum	endian_t { eEndianCount }
	endianess enum More...

Functions
CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint16_t	endian_swap16 (uint16_t value)
	swap the endianess of a 16-bit value More...
CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint32_t	endian_swap32 (uint32_t value)
	swap the endianess of a 32-bit value More...
CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint64_t	endian_swap64 (uint64_t value)
	swap the endianess of a 64-bit value More...
CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint16_t	native_order16 (uint16_t value, endian_t order)
	convert a 16-bit value of a given endianess to the native endianess More...
CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint32_t	native_order32 (uint32_t value, endian_t order)
	convert a 32-bit value of a given endianess to the native endianess More...
CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint64_t	native_order64 (uint64_t value, endian_t order)
	convert a 64-bit value of a given endianess to the native endianess More...

Detailed Description

Macro Definition Documentation

CT_BIG_ENDIAN

#define CT_BIG_ENDIAN   __ORDER_BIG_ENDIAN__

the big endian byte order

CT_BYTE_ORDER

#define CT_BYTE_ORDER   __BYTE_ORDER__

the native byte order

CT_LITTLE_ENDIAN

#define CT_LITTLE_ENDIAN   __ORDER_LITTLE_ENDIAN__

the little endian byte order

Enumeration Type Documentation

endian_t

enum endian_t

endianess enum

Enumerator
eEndianCount

Definition at line 42 of file endian.h.

Function Documentation

endian_swap16()

CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint16_t endian_swap16

(

uint16_t

value

)

swap the endianess of a 16-bit value

Parameters

value

the value to swap

Returns

the swapped value

Definition at line 13 of file endian.c.

endian_swap32()

CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint32_t endian_swap32

(

uint32_t

value

)

swap the endianess of a 32-bit value

Parameters

value

the value to swap

Returns

the swapped value

Definition at line 19 of file endian.c.

endian_swap64()

CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint64_t endian_swap64

(

uint64_t

value

)

swap the endianess of a 64-bit value

Parameters

value

the value to swap

Returns

the swapped value

Definition at line 25 of file endian.c.

native_order16()

CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint16_t native_order16	(	uint16_t	value,
		endian_t	order
	)

convert a 16-bit value of a given endianess to the native endianess

Parameters

value	the value to convert
order	the endianess of value

Returns

the converted value

Definition at line 31 of file endian.c.

native_order32()

CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint32_t native_order32	(	uint32_t	value,
		endian_t	order
	)

convert a 32-bit value of a given endianess to the native endianess

Parameters

value	the value to convert
order	the endianess of value

Returns

the converted value

Definition at line 38 of file endian.c.

native_order64()

CT_NODISCARD CT_CONSTFN CT_ENDIAN_API uint64_t native_order64	(	uint64_t	value,
		endian_t	order
	)

convert a 64-bit value of a given endianess to the native endianess

Parameters

value	the value to convert
order	the endianess of value

Returns

the converted value

Definition at line 45 of file endian.c.