The R Project SVN – R – Diff – /trunk/src/library/base/man/serialize.Rd



\details{
  The function \code{serialize} serializes \code{object} to the specified
  connection.  If \code{connection} is \code{NULL} then \code{object} is
  serialized to a raw vector, which is returned as the result of
  \code{serialize}.
 
  Sharing of reference objects is preserved within the object but not
  across separate calls to \code{serialize}.
 
  \code{unserialize} reads an object (as written by \code{serialize})
  from \code{connection} or a raw vector.

 
  For a text-mode connection, the default value of \code{ascii} is set
  to \code{TRUE}: only ASCII representations can be written to text-mode
  connections and attempting to use \code{ascii = FALSE} will throw an
  error.
 
  The format consists of a single line followed by the data: the first
  line contains a single character: \code{X} for binary serialization
  and \code{A} for ASCII serialization, followed by a new line.  (The
  format used is identical to that used by \code{\link{readRDS}}.)
 

The R Project SVN R

(root)/trunk/src/library/base/man/serialize.Rd – Rev 59039 → 61433

Rev 59039		Rev 61433
Line 35...		Line 35...
35	`\details{`	35	`\details{`
36	`The function \code{serialize} serializes \code{object} to the specified`	36	`The function \code{serialize} serializes \code{object} to the specified`
37	`connection. If \code{connection} is \code{NULL} then \code{object} is`	37	`connection. If \code{connection} is \code{NULL} then \code{object} is`
38	`serialized to a raw vector, which is returned as the result of`	38	`serialized to a raw vector, which is returned as the result of`
39	`\code{serialize}.`	39	`\code{serialize}.`
40		40
41	`Sharing of reference objects is preserved within the object but not`	41	`Sharing of reference objects is preserved within the object but not`
42	`across separate calls to \code{serialize}.`	42	`across separate calls to \code{serialize}.`
43		43
44	`\code{unserialize} reads an object (as written by \code{serialize})`	44	`\code{unserialize} reads an object (as written by \code{serialize})`
45	`from \code{connection} or a raw vector.`	45	`from \code{connection} or a raw vector.`
Line 55...		Line 55...
55		55
56	`For a text-mode connection, the default value of \code{ascii} is set`	56	`For a text-mode connection, the default value of \code{ascii} is set`
57	`to \code{TRUE}: only ASCII representations can be written to text-mode`	57	`to \code{TRUE}: only ASCII representations can be written to text-mode`
58	`connections and attempting to use \code{ascii = FALSE} will throw an`	58	`connections and attempting to use \code{ascii = FALSE} will throw an`
59	`error.`	59	`error.`
60		60
61	`The format consists of a single line followed by the data: the first`	61	`The format consists of a single line followed by the data: the first`
62	`line contains a single character: \code{X} for binary serialization`	62	`line contains a single character: \code{X} for binary serialization`
63	`and \code{A} for ASCII serialization, followed by a new line. (The`	63	`and \code{A} for ASCII serialization, followed by a new line. (The`
64	`format used is identical to that used by \code{\link{readRDS}}.)`	64	`format used is identical to that used by \code{\link{readRDS}}.)`
65		65