ceph/src/arrow/r/man/write_to_raw.Rd

   1 % Generated by roxygen2: do not edit by hand
   2 % Please edit documentation in R/ipc_stream.R
   3 \name{write_to_raw}
   4 \alias{write_to_raw}
   5 \title{Write Arrow data to a raw vector}
   6 \usage{
   7 write_to_raw(x, format = c("stream", "file"))
   8 }
   9 \arguments{
  10 \item{x}{\code{data.frame}, \link{RecordBatch}, or \link{Table}}
  11
  12 \item{format}{one of \code{c("stream", "file")}, indicating the IPC format to use}
  13 }
  14 \value{
  15 A \code{raw} vector containing the bytes of the IPC serialized data.
  16 }
  17 \description{
  18 \code{\link[=write_ipc_stream]{write_ipc_stream()}} and \code{\link[=write_feather]{write_feather()}} write data to a sink and return
  19 the data (\code{data.frame}, \code{RecordBatch}, or \code{Table}) they were given.
  20 This function wraps those so that you can serialize data to a buffer and
  21 access that buffer as a \code{raw} vector in R.
  22 }
  23 \examples{
  24 \dontshow{if (arrow_available()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
  25 # The default format is "stream"
  26 mtcars_raw <- write_to_raw(mtcars)
  27 \dontshow{\}) # examplesIf}
  28 }