Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions r/R/message.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,25 @@

#' @title Message class
#'
#' @description
#' `Message` holds an Arrow IPC message, which includes metadata and
#' an optional message body.
#'
#' @usage NULL
#' @format NULL
#' @docType class
#'
#' @section Methods:
#' @section R6 Methods:
#'
#' - `$Equals(other)`: Check if this `Message` is equal to another `Message`
#' - `$body_length()`: Return the length of the message body in bytes
#' - `$Verify()`: Check if the `Message` metadata is valid Flatbuffer format
#'
#' TODO
#' @section Active bindings:
#'
#' - `$type`: The message type
#' - `$metadata`: The message metadata
#' - `$body`: The message body as a [Buffer]
#'
#' @rdname Message
#' @name Message
Expand All @@ -48,13 +60,23 @@ Message <- R6Class(

#' @title MessageReader class
#'
#' @description
#' `MessageReader` reads `Message` objects from an input stream.
#'
#' @usage NULL
#' @format NULL
#' @docType class
#'
#' @section Methods:
#' @section R6 Methods:
#'
#' - `$ReadNextMessage()`: Read the next `Message` from the stream. Returns `NULL` if
#' there are no more messages.
#'
#' @section Factory:
#'
#' `MessageReader$create()` takes the following argument:
#'
#' TODO
#' - `stream`: An [InputStream] or object coercible to one (e.g., a raw vector)
#'
#' @rdname MessageReader
#' @name MessageReader
Expand Down
Loading