File: blob.Rd

package info (click to toggle)
r-cran-blob 1.2.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 188 kB
  • sloc: sh: 13; makefile: 2
file content (44 lines) | stat: -rw-r--r-- 993 bytes parent folder | download | duplicates (3)
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
33
34
35
36
37
38
39
40
41
42
43
44
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/blob.R
\name{blob}
\alias{blob}
\alias{new_blob}
\alias{validate_blob}
\alias{as_blob}
\alias{is_blob}
\title{Construct a blob object}
\usage{
blob(...)

new_blob(x = list())

validate_blob(x)

as_blob(x)

is_blob(x)
}
\arguments{
\item{...}{Individual raw vectors}

\item{x}{A list of raw vectors, or other object to coerce}
}
\description{
\code{new_blob()} is a low-level constructor that takes a list of
raw vectors.
\code{blob()} constructs a blob from individual raw vectors.
\code{as_blob()} and \code{is_blob()} are simple forwarders to \code{\link[vctrs:vec_cast]{vctrs::vec_cast()}}
and \code{\link[=inherits]{inherits()}}, respectively.
}
\examples{
x1 <- charToRaw("Good morning")
x2 <- as.raw(c(0x48, 0x65, 0x6c, 0x6c, 0x6f))

new_blob(list(x1, x2))
blob(x1, x2)

as.blob(c("Good morning", "Good evening"))
}
\seealso{
\code{\link[=as.blob]{as.blob()}} for the legacy interface for specifying casts.
}