Expand description
Low level bindings to R’s C API
extendr-ffi
powers the extendr-api
library.
Re-exports§
Modules§
- altrep
- ALTREP support
- backports
- Backport functions
- graphics
- Graphics Engine support
- secret 🔒
- symbols 🔒
- Statics representing R Symbols
Structs§
- R_
CMethod Def - These are very similar to those in Rdynpriv.h, but we maintain them separately to give us more freedom to do some computations on the internal versions that are derived from these definitions.
- R_
Call Method Def - R_
inpstream_ st - R_
outpstream_ st - Rcomplex
- R 4.3 redefined
Rcomplex
to a union for compatibility with Fortran. But the old definition is compatible both the union version and the struct version. See: https://github.com/extendr/extendr/issues/524 - SEXPREC
- _Dll
Info
Enums§
- Parse
Status - PARSE_NULL will not be returned by R_ParseVector
- R_
pstream_ format_ t - Rboolean
- A C type with enumeration constants FALSE and TRUE defined.
- SEXPTYPE
- Enum of possible SEXP types
- cetype_
t - cetype_t is an identifier reseved by POSIX, but it is well established as public. Could remap by a #define though
Statics§
- R_
Base ⚠Env - The base environment; formerly R_NilValue
- R_
Base ⚠Namespace - The (fake) namespace for base
- R_
Base ⚠Symbol - “base”
- R_
Blank ⚠Scalar String - “” as a STRSXP
- R_
Blank ⚠String - “” as a CHARSXP
- R_
Brace ⚠Symbol - “{”
- R_
Bracket2 ⚠Symbol - “[[”
- R_
Bracket ⚠Symbol - “[”
- R_
CStack ⚠Limit - C stack limit
- R_
Class ⚠Symbol - “class”
- R_
Device ⚠Symbol - “.Device”
- R_
DimNames ⚠Symbol - “dimnames”
- R_
DimSymbol ⚠ - “dim”
- R_
Dollar ⚠Symbol - “$”
- R_
Dots ⚠Symbol - “…”
- R_
Double ⚠Colon Symbol - “::”
- R_
Drop ⚠Symbol - “drop”
- R_
Empty ⚠Env - An empty environment at the root of the environment tree
- R_
Eval ⚠Symbol - “eval”
- R_
Function ⚠Symbol - “function”
- R_
Global ⚠Env - The “global” environment
- R_
Lastvalue ⚠Symbol - “.Last.value”
- R_
Levels ⚠Symbol - “levels”
- R_
Missing ⚠Arg - Missing argument marker
- R_
Mode ⚠Symbol - “mode”
- R_NaInt⚠
- NA_INTEGER:= INT_MIN currently
- R_NaN⚠
- IEEE NaN
- R_
NaReal ⚠ - NA_REAL: IEEE
- R_
NaRm ⚠Symbol - “na.rm”
- R_
NaString ⚠ - NA_STRING as a CHARSXP
- R_
Name ⚠Symbol - “name”
- R_
Names ⚠Symbol - “names”
- R_
Namespace ⚠EnvSymbol - “.NAMESPACE.”
- R_
Namespace ⚠Registry - Registry for registered namespaces
- R_
NegInf ⚠ - IEEE -Inf
- R_
NilValue ⚠ - The nil object
- R_
Package ⚠Symbol - “package”
- R_
PosInf ⚠ - IEEE Inf
- R_
Previous ⚠Symbol - “previous”
- R_
Quote ⚠Symbol - “quote”
- R_
RowNames ⚠Symbol - “row.names”
- R_
Seeds ⚠Symbol - “.Random.seed”
- R_
Sort ⚠List Symbol - “sort.list”
- R_
Source ⚠Symbol - “source”
- R_
Spec ⚠Symbol - “spec”
- R_
Srcref ⚠ - Current srcref, for debuggers
- R_
Triple ⚠Colon Symbol - “:::”
- R_
TspSymbol ⚠ - “tsp”
- R_
Unbound ⚠Value - Unbound marker
- R_
dot_ ⚠Generic - “.Generic”
- R_
dot_ ⚠Method - “.Method”
- R_
dot_ ⚠defined - “.defined”
- R_
dot_ ⚠package Name - “.packageName”
- R_
dot_ ⚠target - “.target”
Functions§
- CAR⚠
- CDR⚠
- COMPLEX⚠
- COMPLEX_
ELT ⚠ - COMPLEX_
GET_ ⚠REGION - DATAPTR⚠
- DATAPTR_
OR_ ⚠NULL - DATAPTR_
RO ⚠ - GetRN
Gstate ⚠ - INTEGER⚠
- INTEGER_
ELT ⚠ - INTEGER_
GET_ ⚠REGION - INTEGER_
IS_ ⚠SORTED - INTEGER_
NO_ ⚠NA - LENGTH⚠
- LOGICAL⚠
- LOGICAL_
ELT ⚠ - LOGICAL_
GET_ ⚠REGION - MARK_
NOT_ ⚠MUTABLE - PRINTNAME⚠
- PutRN
Gstate ⚠ - RAW⚠
- RAW_
GET_ ⚠REGION - REAL⚠
- REAL_
ELT ⚠ - REAL_
GET_ ⚠REGION - REAL_
IS_ ⚠SORTED - REAL_
NO_ ⚠NA - REprintf⚠
- R_CHAR⚠
- srcref related functions
- R_
Clean ⚠Temp Dir - R_
Clear ⚠External Ptr - R_
External ⚠PtrAddr - R_
External ⚠PtrProtected - R_
External ⚠PtrTag - R_
GetCurrent ⚠Env - R_
GetCurrent ⚠Srcref - srcref related functions
- R_
GetSrc ⚠Filename - R_IsNA⚠
- NA_STRING is a SEXP, so defined in Rinternals.h
- R_IsNaN⚠
- R_
IsNamespace ⚠Env - R_
IsPackage ⚠Env - R_
Make ⚠External Ptr - External pointer interface
- R_
Make ⚠Unwind Cont - R_
Namespace ⚠EnvSpec - R_
NewEnv ⚠ - Environment and Binding Features
- R_
Package ⚠EnvName - R_
Parse ⚠Vector - R_
Preserve ⚠Object - preserve objects across GCs
- R_
RegisterC ⚠Finalizer Ex - R_
Release ⚠Object - R_
RunExit ⚠Finalizers - R_
Serialize ⚠ - R_
SetExternal ⚠PtrAddr - R_
SetExternal ⚠PtrProtected - R_
SetExternal ⚠PtrTag - R_
Unserialize ⚠ - R_
Unwind ⚠Protect - R_
compute_ ⚠identical - R_
do_ ⚠slot - R_
do_ ⚠slot_ assign - R_
finite ⚠ - R_
force ⚠Symbols - R_
has_ ⚠slot - R_
register ⚠Routines - R_
tryEval ⚠ - R_
tryEval ⚠Silent - R_
unif_ ⚠index - R_
useDynamic ⚠Symbols - Rf_
GetArray ⚠Dimnames - Rf_
GetCol ⚠Names - Rf_
GetRow ⚠Names - Rf_
NoDevices ⚠ - Rf_
NumDevices ⚠ - Rf_
Pair ⚠ToVector List - Rf_
Print ⚠Value - Rf_
Scalar ⚠Integer - Rf_
Vector ⚠ToPair List - Rf_
alloc ⚠Matrix - Rf_
alloc ⚠Vector - Rf_
asChar ⚠ - Rf_
asCharacter ⚠Factor - Rf_
coerce ⚠Vector - Rf_
conformable ⚠ - Rf_cons⚠
- Rf_
define ⚠Var - Rf_
dimgets ⚠ - Rf_
dimnamesgets ⚠ - Rf_
duplicate ⚠ - Rf_
error ⚠ - Rf_
find ⚠Fun - Rf_
getAttrib ⚠ - Rf_
initialize_ ⚠R - Rf_
install ⚠ - Rf_
isArray ⚠ - Rf_
isComplex ⚠ - Rf_
isEnvironment ⚠ - Rf_
isExpression ⚠ - Rf_
isFactor ⚠ - Rf_
isFrame ⚠ - Rf_
isFunction ⚠ - Rf_
isInteger ⚠ - Rf_
isLanguage ⚠ - Rf_
isList ⚠ - Rf_
isLogical ⚠ - Rf_
isMatrix ⚠ - Rf_
isNew ⚠List - Rf_
isNull ⚠ - Rf_
isNumber ⚠ - Rf_
isObject ⚠ - Rf_
isPrimitive ⚠ - Rf_
isReal ⚠ - Rf_isS4⚠
- Rf_
isString ⚠ - Rf_
isSymbol ⚠ - Rf_isTs⚠
- Rf_
isUser ⚠Binop - Rf_
isVector ⚠ - Rf_
isVector ⚠Atomic - Rf_
isVector ⚠List - Rf_
isVectorizable ⚠ - Rf_
lang1 ⚠ - Rf_
lcons ⚠ - Rf_
mkChar ⚠LenCE - Rf_
namesgets ⚠ - Rf_
ncols ⚠ - Rf_
nrows ⚠ - Rf_
protect ⚠ - Rf_
runif ⚠ - Rf_
setAttrib ⚠ - Rf_
unprotect ⚠ - Rf_
xlength ⚠ - Rf_
xlengthgets ⚠ - Rprintf⚠
- SETCDR⚠
- SETLEVELS⚠
- SET_
ATTRIB ⚠ - SET_
INTEGER_ ⚠ELT - SET_
OBJECT ⚠ - SET_
REAL_ ⚠ELT - SET_
STRING_ ⚠ELT - SET_TAG⚠
- SET_
VECTOR_ ⚠ELT - STRING_
ELT ⚠ - STRING_
IS_ ⚠SORTED - STRING_
NO_ ⚠NA - STRING_
PTR_ ⚠RO - TAG⚠
- TYPEOF⚠
- Returns the SEXPTYPE of
x
- VECTOR_
ELT ⚠ - XLENGTH⚠
- setup_
Rmainloop ⚠
Type Aliases§
- DL_FUNC
- Called with a variable argument set after casting to a compatible function pointer.
- DllInfo
- Int32
- R_
CFinalizer_ t - Finalization interface
- R_
External Method Def - R_
Fortran Method Def - R_
Native Primitive ArgType - R_
inpstream_ t - R_len_t
- type for length of (standard, not long) vectors etc
- R_
outpstream_ t - R_
pstream_ data_ t - R_
xlen_ t - R_xlen_t is defined as int on 32-bit platforms, and that confuses Rust. Keeping it always as ptrdiff_t works fine even on 32-bit.
- Rbyte
- SEXP