FutureCondition: A condition (message, warning, or error) that occurred while...

View source: R/protected_api-FutureCondition-class.R

FutureConditionR Documentation

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, uuid = future[["uuid"]], future = NULL)

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(...)

FutureInterruptError(..., future = NULL)

FutureDroppedError(..., future = NULL)

FutureJournalCondition(
  message,
  journal,
  call = NULL,
  uuid = future[["uuid"]],
  future = NULL
)

Arguments

message

A message condition.

call

The call stack that led up to the condition.

uuid

A universally unique identifier for the future associated with this FutureCondition.

future

The Future involved.

hint

(optional) A string with a suggestion on what might be wrong.

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.


future documentation built on April 12, 2025, 1:25 a.m.