pub struct Function { /* private fields */ }
Expand description
Wrapper for creating functions (CLOSSXP).
use extendr_api::prelude::*;
test! {
// Closures are functions.
let expr = R!("function(a = 1, b) {c <- a + b}")?;
let func = expr.as_function().unwrap();
let expected_formals = Pairlist::from_pairs(vec![("a", r!(1.0)), ("b", missing_arg().into())]);
let expected_body = lang!(
"{", lang!("<-", sym!(c), lang!("+", sym!(a), sym!(b))));
assert_eq!(func.formals().unwrap(), expected_formals);
assert_eq!(func.body().unwrap(), expected_body);
assert_eq!(func.environment().unwrap(), global_env());
// Primitives can also be functions.
let expr = R!("`~`")?;
let func = expr.as_function().unwrap();
assert_eq!(func.formals(), None);
assert_eq!(func.body(), None);
assert_eq!(func.environment(), None);
}
Implementations
sourceimpl Function
impl Function
sourcepub fn from_parts(
formals: Pairlist,
body: Language,
env: Environment
) -> Result<Self>
pub fn from_parts(
formals: Pairlist,
body: Language,
env: Environment
) -> Result<Self>
Make a function from parts.
use extendr_api::prelude::*;
test! {
let formals = pairlist!(a=NULL);
let body = lang!("+", sym!(a), r!(1)).try_into()?;
let env = global_env();
let f = r!(Function::from_parts(formals, body, env )?);
assert_eq!(f.call(pairlist!(a=1))?, r!(2));
}
sourcepub fn call(&self, args: Pairlist) -> Result<Robj>
pub fn call(&self, args: Pairlist) -> Result<Robj>
Do the equivalent of x(a, b, c)
use extendr_api::prelude::*;
test! {
let function = R!("function(a, b) a + b").unwrap().as_function().unwrap();
assert_eq!(function.call(pairlist!(a=1, b=2)).unwrap(), r!(3));
}
sourcepub fn formals(&self) -> Option<Pairlist>
pub fn formals(&self) -> Option<Pairlist>
Get the formal arguments of the function or None if it is a primitive.
sourcepub fn environment(&self) -> Option<Environment>
pub fn environment(&self) -> Option<Environment>
Get the environment of the function or None if it is a primitive.
Trait Implementations
sourceimpl Conversions for Function
impl Conversions for Function
as_*()
sourcefn as_language(&self) -> Option<Language>
fn as_language(&self) -> Option<Language>
Convert a language object to a Language wrapper. Read more
sourcefn as_pairlist(&self) -> Option<Pairlist>
fn as_pairlist(&self) -> Option<Pairlist>
Convert a pair list object (LISTSXP) to a Pairlist wrapper. Read more
sourcefn as_expressions(&self) -> Option<Expressions>
fn as_expressions(&self) -> Option<Expressions>
Convert an expression object (EXPRSXP) to a Expr wrapper. Read more
sourcefn as_environment(&self) -> Option<Environment>
fn as_environment(&self) -> Option<Environment>
Convert an environment object (ENVSXP) to a Env wrapper. Read more
sourcefn as_function(&self) -> Option<Function>
fn as_function(&self) -> Option<Function>
Convert a function object (CLOSXP) to a Function wrapper. Read more
sourcefn as_promise(&self) -> Option<Promise>
fn as_promise(&self) -> Option<Promise>
Get a wrapper for a promise.
sourceimpl Operators for Function
impl Operators for Function
dollar() etc.
sourcefn dollar<T>(&self, symbol: T) -> Result<Robj> where
T: AsRef<str>,
fn dollar<T>(&self, symbol: T) -> Result<Robj> where
T: AsRef<str>,
Do the equivalent of x$y Read more
sourcefn slice<T>(&self, rhs: T) -> Result<Robj> where
T: Into<Robj>,
fn slice<T>(&self, rhs: T) -> Result<Robj> where
T: Into<Robj>,
Do the equivalent of x[y]
Read more
sourcefn index<T>(&self, rhs: T) -> Result<Robj> where
T: Into<Robj>,
fn index<T>(&self, rhs: T) -> Result<Robj> where
T: Into<Robj>,
Do the equivalent of x[[y]]
Read more
sourcefn tilde<T>(&self, rhs: T) -> Result<Robj> where
T: Into<Robj>,
fn tilde<T>(&self, rhs: T) -> Result<Robj> where
T: Into<Robj>,
Do the equivalent of x ~ y Read more
sourceimpl Rinternals for Function
impl Rinternals for Function
find_var() etc.
sourcefn is_logical(&self) -> bool
fn is_logical(&self) -> bool
Return true if this is a boolean (logical) vector
sourcefn is_complex(&self) -> bool
fn is_complex(&self) -> bool
Return true if this is a complex vector.
sourcefn is_expressions(&self) -> bool
fn is_expressions(&self) -> bool
Return true if this is an expression.
sourcefn is_environment(&self) -> bool
fn is_environment(&self) -> bool
Return true if this is an environment.
sourcefn is_promise(&self) -> bool
fn is_promise(&self) -> bool
Return true if this is an environment.
sourcefn is_external_pointer(&self) -> bool
fn is_external_pointer(&self) -> bool
Return true if this is an expression.
sourcefn get_current_srcref(val: i32) -> Robj
fn get_current_srcref(val: i32) -> Robj
Get the source ref.
sourcefn get_src_filename(&self) -> Robj
fn get_src_filename(&self) -> Robj
Get the source filename.
sourcefn as_character_vector(&self) -> Robj
fn as_character_vector(&self) -> Robj
Convert to a string vector.
sourcefn coerce_vector(&self, sexptype: u32) -> Robj
fn coerce_vector(&self, sexptype: u32) -> Robj
Convert to vectors of many kinds.
sourcefn pair_to_vector_list(&self) -> Robj
fn pair_to_vector_list(&self) -> Robj
Convert a pairlist (LISTSXP) to a vector list (VECSXP).
sourcefn vector_to_pair_list(&self) -> Robj
fn vector_to_pair_list(&self) -> Robj
Convert a vector list (VECSXP) to a pair list (LISTSXP)
sourcefn as_character_factor(&self) -> Robj
fn as_character_factor(&self) -> Robj
Convert a factor to a string vector.
sourcefn alloc_matrix(sexptype: SEXPTYPE, rows: i32, cols: i32) -> Robj
fn alloc_matrix(sexptype: SEXPTYPE, rows: i32, cols: i32) -> Robj
Allocate a matrix object.
sourcefn duplicate(&self) -> Robj
fn duplicate(&self) -> Robj
Do a deep copy of this object. Note that clone() only adds a reference. Read more
sourcefn find_function<K: TryInto<Symbol, Error = Error>>(
&self,
key: K
) -> Result<Robj>
fn find_function<K: TryInto<Symbol, Error = Error>>(
&self,
key: K
) -> Result<Robj>
Find a function in an environment ignoring other variables. Read more
sourcefn find_var<K: TryInto<Symbol, Error = Error>>(&self, key: K) -> Result<Robj>
fn find_var<K: TryInto<Symbol, Error = Error>>(&self, key: K) -> Result<Robj>
Find a variable in an environment. Read more
sourcefn eval_promise(&self) -> Result<Robj>
fn eval_promise(&self) -> Result<Robj>
If this object is a promise, evaluate it, otherwise return the object. Read more
sourcefn xlengthgets(&self, new_len: usize) -> Result<Robj>
fn xlengthgets(&self, new_len: usize) -> Result<Robj>
Copy a vector and resize it. See. https://github.com/hadley/r-internals/blob/master/vectors.md Read more
sourcefn alloc_vector(sexptype: u32, len: usize) -> Robj
fn alloc_vector(sexptype: u32, len: usize) -> Robj
Allocated an owned object of a certain type.
sourcefn conformable(a: &Robj, b: &Robj) -> bool
fn conformable(a: &Robj, b: &Robj) -> bool
Return true if two arrays have identical dims.
sourcefn is_function(&self) -> bool
fn is_function(&self) -> bool
Return true if this is a function or a primitive (CLOSXP, BUILTINSXP or SPECIALSXP)
sourcefn is_integer(&self) -> bool
fn is_integer(&self) -> bool
Return true if this is an integer vector (INTSXP) but not a factor.
sourcefn is_language(&self) -> bool
fn is_language(&self) -> bool
Return true if this is a language object (LANGSXP).
sourcefn is_pairlist(&self) -> bool
fn is_pairlist(&self) -> bool
Return true if this is NILSXP or LISTSXP.
sourcefn is_primitive(&self) -> bool
fn is_primitive(&self) -> bool
Return true if this is a primitive function BUILTINSXP, SPECIALSXP.
sourcefn is_user_binop(&self) -> bool
fn is_user_binop(&self) -> bool
Return true if this is a user defined binop.
sourcefn is_valid_string(&self) -> bool
fn is_valid_string(&self) -> bool
Return true if this is a valid string.
sourcefn is_valid_string_f(&self) -> bool
fn is_valid_string_f(&self) -> bool
Return true if this is a valid string.
sourcefn is_vector_atomic(&self) -> bool
fn is_vector_atomic(&self) -> bool
Return true if this is an atomic vector.
sourcefn is_vector_list(&self) -> bool
fn is_vector_list(&self) -> bool
Return true if this is a vector list.
sourcefn is_vectorizable(&self) -> bool
fn is_vectorizable(&self) -> bool
Return true if this is can be made into a vector.
fn is_missing_arg(&self) -> bool
fn is_unbound_value(&self) -> bool
fn is_package_env(&self) -> bool
fn package_env_name(&self) -> Robj
fn is_namespace_env(&self) -> bool
fn namespace_env_spec(&self) -> Robj
sourcefn is_altinteger(&self) -> bool
fn is_altinteger(&self) -> bool
Returns true
if this is an integer ALTREP object.
sourcefn is_altreal(&self) -> bool
fn is_altreal(&self) -> bool
Returns true
if this is an real ALTREP object.
sourcefn is_altlogical(&self) -> bool
fn is_altlogical(&self) -> bool
Returns true
if this is an logical ALTREP object.
sourcefn is_altstring(&self) -> bool
fn is_altstring(&self) -> bool
Returns true
if this is an integer ALTREP object.
sourceimpl Slices for Function
impl Slices for Function
as_typed_slice_raw() etc.
impl StructuralPartialEq for Function
Auto Trait Implementations
impl RefUnwindSafe for Function
impl !Send for Function
impl !Sync for Function
impl Unpin for Function
impl UnwindSafe for Function
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more