FutureCondition: A condition (message, warning, or error) that occurred while orchestrating a future

Description

While orchestrating (creating, launching, querying, collection) futures, unexpected run-time errors (and other types of conditions) may occur. Such conditions are coerced to a corresponding FutureCondition class to help distinguish them from conditions that occur due to the evaluation of the future.

Usage

FutureCondition(
  message,
  call = NULL,
  by = session_uuid(),
  when = NULL,
  uuid = future[["uuid"]],
  label = future[["label"]],
  future = NULL,
  drop = FALSE
)
FutureMessage(
  message,
  call = NULL,
  ...,
  uuid = future[["uuid"]],
  future = NULL
)
FutureWarning(
  message,
  call = NULL,
  ...,
  uuid = future[["uuid"]],
  future = NULL
)
FutureError(message, call = NULL, ..., uuid = future[["uuid"]], future = NULL)
RngFutureCondition(
  message = NULL,
  call = NULL,
  ...,
  uuid = future[["uuid"]],
  future = NULL
)
RngFutureWarning(...)
RngFutureError(...)
UnexpectedFutureResultError(future, hint = NULL)
GlobalEnvMisuseFutureCondition(
  message = NULL,
  call = NULL,
  ...,
  differences = NULL,
  uuid = future[["uuid"]],
  future = NULL
)
GlobalEnvMisuseFutureWarning(...)
GlobalEnvMisuseFutureError(...)
ConnectionMisuseFutureCondition(
  message = NULL,
  call = NULL,
  ...,
  differences = NULL,
  uuid = future[["uuid"]],
  future = NULL
)
ConnectionMisuseFutureWarning(...)
ConnectionMisuseFutureError(...)
DeviceMisuseFutureCondition(
  message = NULL,
  call = NULL,
  ...,
  differences = NULL,
  uuid = future[["uuid"]],
  future = NULL
)
DeviceMisuseFutureWarning(...)
DeviceMisuseFutureError(...)
DefaultDeviceMisuseFutureCondition(
  message = NULL,
  call = NULL,
  ...,
  incidents = NULL,
  uuid = future[["uuid"]],
  future = NULL
)
DefaultDeviceMisuseFutureWarning(...)
DefaultDeviceMisuseFutureError(...)
FutureLaunchError(..., future = NULL)
FutureInterruptError(
  message = "A future was interrupted",
  when = Sys.time(),
  future = NULL
)
FutureCanceledError(..., future = NULL)
FutureDroppedError(..., future = NULL)
FutureJournalCondition(
  message,
  journal,
  call = NULL,
  uuid = future[["uuid"]],
  future = NULL
)

Value

An object of class FutureCondition which inherits from class condition and FutureMessage, FutureWarning, and FutureError all inherits from FutureCondition. Moreover, a FutureError inherits from error, a FutureWarning from warning, and a FutureMessage from message.

Arguments

message: A message condition.
call: (optional) The call stack that led up to the condition.
by: (optional) A session UUID object.
when: (optional) A POSIXct timestamp for when the condition was created.
uuid: (optional) A universally unique identifier for the future associated with this FutureCondition.
label: (optional) A future label.
future: (optional) The Future involved.
drop: If TRUE, the future argument is only used to populate future metadata, but is not stored in the condition object created.
hint: (optional) A string with a suggestion on what might be wrong.