Package 'hellorust'

Title: Minimal Examples of Using Rust Code in R
Description: Template R package with minimal setup to use Rust code in R without hacks or frameworks. Includes basic examples of importing cargo dependencies, spawning threads and passing numbers or strings from Rust to R. Cargo crates are automatically 'vendored' in the R source package to support offline installation. The GitHub repository for this package has more details and also explains how to set up CI. This project was first presented at 'Erum2018' to showcase R-Rust integration <https://jeroen.github.io/erum2018/>; for a real world use-case, see the 'gifski' package on 'CRAN'.
Authors: Jeroen Ooms [aut, cre] , Authors of the dependency Rust crates [aut] (see AUTHORS file)
Maintainer: Jeroen Ooms <[email protected]>
License: MIT + file LICENSE
Version: 1.2.0
Built: 2024-07-03 06:17:17 UTC
Source: https://github.com/r-rust/hellorust

Help Index


Hello Rust!

Description

Minimal examples of calling rust functions in R via C.

Usage

hello()

random()

runthreads()

Details

These functions call out to rust functions defined in the 'myrustlib' cargo crate which is embedded in this package. They return values generated in Rust, such as a UTF-8 string or random number. In addition, 'runthreads' is an example of a multi-threaded rust function.

Value

a value generated in Rust (a string, random number, and NULL respectively).

Examples

hello()
random()
runthreads()