File: Buffer-class.Rd

package info (click to toggle)
apache-arrow 23.0.1-1
  • links: PTS
  • area: main
  • in suites: sid
  • size: 76,220 kB
  • sloc: cpp: 654,608; python: 70,522; ruby: 45,964; ansic: 18,742; sh: 7,365; makefile: 669; javascript: 125; xml: 41
file content (32 lines) | stat: -rw-r--r-- 765 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/buffer.R
\docType{class}
\name{Buffer}
\alias{Buffer}
\title{Buffer class}
\description{
A Buffer is an object containing a pointer to a piece of
contiguous memory with a particular size.
}
\section{Factory}{

\code{buffer()} lets you create an \code{arrow::Buffer} from an R object
}

\section{Methods}{

\itemize{
\item \verb{$is_mutable} : is this buffer mutable?
\item \verb{$ZeroPadding()} : zero bytes in padding, i.e. bytes between size and capacity
\item \verb{$size} : size in memory, in bytes
\item \verb{$capacity}: possible capacity, in bytes
}
}

\examples{
my_buffer <- buffer(c(1, 2, 3, 4))
my_buffer$is_mutable
my_buffer$ZeroPadding()
my_buffer$size
my_buffer$capacity
}