doc.odin 949 B

1234567891011121314151617181920212223
  1. /*
  2. Package endian implements a simple translation between bytes and numbers with
  3. specific endian encodings.
  4. buf: [100]u8
  5. put_u16(buf[:], .Little, 16) or_return
  6. You may ask yourself, why isn't `byte_order` platform Endianness by default, so we can write:
  7. put_u16(buf[:], 16) or_return
  8. The answer is that very few file formats are written in native/platform endianness. Most of them specify the endianness of
  9. each of their fields, or use a header field which specifies it for the entire file.
  10. e.g. a file which specifies it at the top for all fields could do this:
  11. file_order := .Little if buf[0] == 0 else .Big
  12. field := get_u16(buf[1:], file_order) or_return
  13. If on the other hand a field is *always* Big-Endian, you're wise to explicitly state it for the benefit of the reader,
  14. be that your future self or someone else.
  15. field := get_u16(buf[:], .Big) or_return
  16. */
  17. package encoding_endian