basis/serialize/serialize-docs.factor

   1 ! Copyright (C) 2006 Chris Double.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.syntax help.markup ;
   4 IN: serialize
   5
   6 HELP: serialize
   7 { $values { "obj" "object to serialize" }
   8 }
   9 { $description "Serializes the object to the current output stream. Object references within the structure being serialized are maintained." }
  10 { $examples
  11     { $example "USING: serialize io.encodings.binary io.streams.byte-array prettyprint ;" "binary [ { 1 2 } serialize ] with-byte-writer\n\nbinary [ deserialize ] with-byte-reader ." "{ 1 2 }" }
  12 }
  13 { $see-also deserialize } ;
  14
  15 HELP: deserialize
  16 { $values { "obj" "deserialized object" }
  17 }
  18 { $description "Deserializes an object by reading from the current input stream. Object references within the structure that was originally serialized are maintained." }
  19 { $examples
  20     { $example "USING: serialize io.encodings.binary io.streams.byte-array prettyprint ;" "binary [ { 1 2 } serialize ] with-byte-writer\n\nbinary [ deserialize ] with-byte-reader ." "{ 1 2 }" }
  21 }
  22 { $see-also serialize } ;