core/byte-arrays/byte-arrays-docs.factor

   1 USING: kernel help.markup help.syntax ;
   2 IN: byte-arrays
   3
   4 ARTICLE: "byte-arrays" "Byte arrays"
   5 "Byte arrays are fixed-size mutable sequences (" { $link "sequence-protocol" } ") whose elements are integers in the range 0-255, inclusive. Each element only uses one byte of storage, hence the name. The literal syntax is covered in " { $link "syntax-byte-arrays" } "."
   6 $nl
   7 "Byte array words are in the " { $vocab-link "byte-arrays" } " vocabulary."
   8 $nl
   9 "Byte arrays play a special role in the C library interface; they can be used to pass binary data back and forth between Factor and C. See " { $link "c-byte-arrays" } "."
  10 $nl
  11 "Byte arrays form a class of objects."
  12 { $subsection byte-array }
  13 { $subsection byte-array? }
  14 "There are several ways to construct byte arrays."
  15 { $subsection >byte-array }
  16 { $subsection <byte-array> }
  17 { $subsection 1byte-array }
  18 { $subsection 2byte-array }
  19 { $subsection 3byte-array }
  20 { $subsection 4byte-array }
  21 "Resizing byte-arrays:"
  22 { $subsection resize-byte-array } ;
  23
  24 ABOUT: "byte-arrays"
  25
  26 HELP: byte-array
  27 { $description "The class of byte arrays. See " { $link "syntax-byte-arrays" } " for syntax and " { $link "byte-arrays" } " for general information." } ;
  28
  29 HELP: <byte-array> ( n -- byte-array )
  30 { $values { "n" "a non-negative integer" } { "byte-array" "a new byte array" } }
  31 { $description "Creates a new byte array holding " { $snippet "n" } " bytes." } ;
  32
  33 HELP: (byte-array)
  34 { $values { "n" "a non-negative integer" } { "byte-array" "a new byte array" } }
  35 { $description "Creates a new byte array with unspecified contents of length " { $snippet "n" } " bytes." } ;
  36
  37 HELP: >byte-array
  38 { $values { "seq" "a sequence" } { "byte-array" byte-array } }
  39 { $description
  40   "Outputs a freshly-allocated byte array whose elements have the same signed byte values as a given sequence." }
  41 { $errors "Throws an error if the sequence contains elements other than integers." } ;
  42
  43 HELP: 1byte-array
  44 { $values
  45      { "x" object }
  46      { "byte-array" byte-array } }
  47 { $description "Creates a new byte-array with one element." } ;
  48
  49 HELP: 2byte-array
  50 { $values
  51      { "x" object } { "y" object }
  52      { "byte-array" byte-array } }
  53 { $description "Creates a new byte-array with two elements." } ;
  54
  55 HELP: 3byte-array
  56 { $values
  57      { "x" object } { "y" object } { "z" object }
  58      { "byte-array" byte-array } }
  59 { $description "Creates a new byte-array with three element." } ;
  60
  61 HELP: 4byte-array
  62 { $values
  63      { "w" object } { "x" object } { "y" object } { "z" object }
  64      { "byte-array" byte-array } }
  65 { $description "Creates a new byte-array with four elements." } ;
  66
  67 { 1byte-array 2byte-array 3byte-array 4byte-array } related-words
  68
  69 HELP: resize-byte-array ( n byte-array -- newbyte-array )
  70 { $values { "n" "a non-negative integer" } { "byte-array" byte-array }
  71         { "newbyte-array" byte-array } }
  72 { $description "Creates a new byte-array of n elements.  The contents of the existing byte-array are copied into the new byte-array; if the new byte-array is shorter, only an initial segment is copied, and if the new byte-array is longer the remaining space is filled in with 0." } ;