Struct RAssertion 

struct RAssertion {
    param: String,
    requirement: String,
    condition: String,
    message: Option<String>,
}

A single R-side check on one parameter: a requirement and the R condition enforcing it.

Formatted as a guard (see RAssertion::to_guard): if (!isTRUE(is.numeric(x))) .miniextendr_arg_error("x", "must be numeric").

Fields

param: String

R name of the checked parameter (e$param on failure).

requirement: String

What the parameter must satisfy, without the parameter name (must be numeric). The condition message is '<param>' <requirement>.

condition: String

R expression that must evaluate to TRUE for the check to pass.

message: Option<String>

The author’s own condition message (message = "..." on inherits / not_inherits / no_na; an inherits message also on the parameter’s type checks), used verbatim instead of '<param>' <requirement>.

Implementations

impl RAssertion

fn new( param: impl Into<String>, requirement: impl Into<String>, condition: impl Into<String>, ) -> Self

Create a new assertion on param with its requirement and R condition expression.

fn with_message(self, message: Option<&String>) -> Self

Use message verbatim as the condition message of a failure.

fn to_guard(&self, call: Option<&str>) -> String

Format as a guard that raises an argument error on failure: if (!isTRUE(condition)) .miniextendr_arg_error("param", "requirement"), or with the author’s message if (!isTRUE(condition)) .miniextendr_arg_error("param", message = "...").

call is the call the error is attributed to. None leaves the helper’s default, the wrapper’s own call (what stopifnot() reported); a call = caller wrapper passes .mx_call (#1548). Next to a named message the call is named too: positionally it would bind to what.

fn nullable(self) -> Self

Wrap for nullable: prepend is.null(param) || to the condition, and adjust the requirement to mention NULL.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 96 bytes