resp_stream_raw {httr2} | R Documentation |
Read a streaming body a chunk at a time
Description
-
resp_stream_raw()
retrieves bytes (raw
vectors). -
resp_stream_lines()
retrieves lines of text (character
vectors). -
resp_stream_sse()
retrieves a single server-sent event. -
resp_stream_aws()
retrieves a single event from an AWS stream (i.e. mime type 'application/vnd.amazon.eventstream“).
Usage
resp_stream_raw(resp, kb = 32)
resp_stream_lines(resp, lines = 1, max_size = Inf, warn = TRUE)
resp_stream_sse(resp, max_size = Inf)
resp_stream_aws(resp, max_size = Inf)
## S3 method for class 'httr2_response'
close(con, ...)
Arguments
resp , con |
A streaming response created by |
kb |
How many kilobytes (1024 bytes) of data to read. |
lines |
The maximum number of lines to return at once. |
max_size |
The maximum number of bytes to buffer; once this number of bytes has been exceeded without a line/event boundary, an error is thrown. |
warn |
Like |
... |
Not used; included for compatibility with generic. |
Value
-
resp_stream_raw()
: a raw vector. -
resp_stream_lines()
: a character vector. -
resp_stream_sse()
: a list with componentstype
,data
, andid
-
resp_stream_aws()
: a list with componentsheaders
andbody
.body
will be automatically parsed if the event contents a:content-type
header withapplication/json
.
resp_stream_sse()
and resp_stream_aws()
will return NULL
to signal that
the end of the stream has been reached or, if in nonblocking mode, that
no event is currently available.