-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Exposes the native endianness or byte ordering of the system.
--   
--   This package is for working with the native byte-ordering of the
--   system.
@package byteorder
@version 1.0.3

module System.ByteOrder

-- | Returns the native byte ordering of the system.
byteOrder :: ByteOrder

-- | Indicates the byte-ordering for a 4-byte value, where '1' indicates
--   the most-significant byte and '4' indicates the least significant
--   byte.
--   
--   In this format, big endian byte order would be represented as:
--   (1,2,3,4).
--   
--   For convinience, the most common cases (BigEndian and LittleEndian)
--   are provided their own constructors.
data ByteOrder
BigEndian :: ByteOrder
LittleEndian :: ByteOrder
Mixed :: (Word8, Word8, Word8, Word8) -> ByteOrder
instance Eq ByteOrder
instance Show ByteOrder
instance Read ByteOrder
instance Ord ByteOrder