A simple low-level interface for serializing to connections.
1 2 3 4
R object to serialize.
an open connection or (for
a logical. If
a logical: if a binary representation is used, should a big-endian one (XDR) be used?
the workspace format version to use.
a hook function for handling reference objects.
object to the specified
serialized to a raw vector, which is returned as the result of
Sharing of reference objects is preserved within the object but not
across separate calls to
unserialize reads an object (as written by
connection or a raw vector.
refhook functions can be used to customize handling of
non-system reference objects (all external pointers and weak
references, and all environments other than namespace and package
.GlobalEnv). The hook function for
serialize should return a character vector for references it
wants to handle; otherwise it should return
NULL. The hook for
unserialize will be called with character vectors supplied to
serialize and should return an appropriate object.
For a text-mode connection, the default value of
ascii is set
TRUE: only ASCII representations can be written to text-mode
connections and attempting to use
ascii = FALSE will throw an
The format consists of a single line followed by the data: the first
line contains a single character:
X for binary serialization
A for ASCII serialization, followed by a new line. (The
format used is identical to that used by
The option of
xdr = FALSE was introduced in R 2.15.0. As
almost all systems in current use are little-endian, this can be used
to avoid byte-shuffling at both ends when transferring data from one
little-endian machine to another (or between processes on the same
machine). Depending on the system, this can speed up serialization
and unserialization by a factor of up to 3x.
connection = NULL, when
the result is returned in a raw vector.
unserialize an R object.
These functions have provided a stable interface since R 2.4.0 (when the storage of serialized objects was changed from character to raw vectors). However, the serialization format may change in future versions of R, so this interface should not be used for long-term storage of R objects.
On 32-bit platforms a raw vector is limited to 2^31 - 1 bytes, but R objects can exceed this and their serializations will normally be larger than the objects.
saveRDS for a more convenient interface to serialize an
object to a file or connection.
load to serialize and restore one
or more named objects.
The ‘R Internals’ manual for details of the format used.
1 2 3 4
Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.