narrow_array_stream: Stream objects as Arrow arrays

View source: R/array-stream.R

narrow_array_streamR Documentation

Stream objects as Arrow arrays

Description

Stream objects as Arrow arrays

Usage

narrow_array_stream(list_of_array = list(), schema = NULL, validate = TRUE)

narrow_array_stream_collect(array_stream, ptype = NULL)

narrow_array_stream_get_schema(array_stream)

narrow_array_stream_get_next(array_stream, validate = TRUE)

as_narrow_array_stream(x, ...)

## S3 method for class 'narrow_array_stream'
as_narrow_array_stream(x, ...)

## S3 method for class 'list'
as_narrow_array_stream(x, ...)

## S3 method for class ''function''
as_narrow_array_stream(x, ...)

## Default S3 method:
as_narrow_array_stream(x, ...)

## S3 method for class 'narrow_array'
as_narrow_array_stream(x, ...)

Arguments

list_of_array

A list() of narrow_array()s.

schema

The schema for all the arrays in list_of_array.

validate

Use FALSE to skip validation of arrays in list_of_array.

array_stream

An object of class "narrow_array_stream"

ptype

An R object to use as a prototype

x

An R object to convert to an Arrow Stream

...

Passed to S3 methods

Value

An object of class "narrow_array_stream"


paleolimbot/arrowvctrs documentation built on Oct. 12, 2023, 7 a.m.