Struct Formals 

pub(crate) struct Formals {
    declared: HashMap<String, LitStr>,
}

The R formal of each parameter of one signature (#1842).

A parameter declared with formal = "conf.int" (a standalone function’s per-parameter option, a method’s formal(conf_int = "conf.int")) has that formal; every other one has normalize_r_arg_string of its Rust name. Formals::of is the one place that rule lives: every site that writes a parameter’s name into R text (the formals, the .Call() arguments, the argument checks and their errors, e$param of a conversion error, the @param lines) asks it. Maps keyed by Rust name (the per-parameter options) stay keyed by Rust name, and so do the match_arg placeholders, which the wrapper writer replaces before R reads them.

A declared formal may hold a ., which no Rust identifier can, so it is only ever a string: never an identifier, and never part of one.

Fields

declared: HashMap<String, LitStr>

The declared formals, keyed by Rust parameter name (crate::naming::ident_name), each with the literal that declared it (where its errors point).

Implementations

impl Formals

pub(crate) fn from_param_attrs(per_param: &HashMap<String, ParamAttrs>) -> Self

The formals the per-parameter options of one signature declare.

pub(crate) fn of(&self, rust_name: &str) -> String

The R formal of the parameter whose Rust name is rust_name: its declared formal, else the name without leading underscores.

pub(crate) fn of_ident(&self, ident: &Ident) -> String

Self::of the parameter ident (r# dropped).

pub(crate) fn declared(&self, rust_name: &str) -> Option<&LitStr>

The literal that declared the formal of rust_name, if one did.

pub(crate) fn rekey<V>( &self, map: impl IntoIterator<Item = (String, V)>, ) -> HashMap<String, V>

map with each key, a Rust parameter name, replaced by that parameter’s R formal: for maps keyed by Rust name (a function’s default = "..", a method’s defaults(p = "..")) that feed a builder keyed by R formal.

Trait Implementations

impl Clone for Formals

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Formals

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Formals

fn default() -> Self

Returns the “default value” for a type.

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: 48 bytes