extra/leb128/leb128-docs.factor

   1
   2 USING: byte-arrays help.markup help.syntax ;
   3
   4 IN: leb128
   5
   6 ARTICLE: "leb128" "LEB128 Encoding"
   7
   8 LEB128 (Little Endian Base 128) is a variable-length encoding format designed
   9 to store arbitrarily large integers in a small number of bytes. There are two
  10 versions: unsigned and signed. These vary slightly, so a user program that
  11 wants to decode LEB128 values should use the appropriate unsigned or signed
  12 decode method.
  13
  14 Unsigned LEB128:
  15 { $subsections
  16     >uleb128
  17     uleb128>
  18     write-uleb128
  19     stream-write-uleb128
  20     read-uleb128
  21     stream-read-uleb128
  22 }
  23
  24 Signed LEB128:
  25 { $subsections
  26     >leb128
  27     leb128>
  28     write-leb128
  29     stream-write-leb128
  30     read-leb128
  31     stream-read-leb128
  32 } ;
  33
  34 ABOUT: "leb128"