Struct REngineBuilder

Source

pub struct REngineBuilder {
    pub(crate) args: Vec<String>,
    pub(crate) interactive: bool,
    pub(crate) signal_handlers: bool,
}

Expand description

Builder for configuring and initializing the R runtime.

§Example

let engine = REngine::build()
    .with_args(&["R", "--quiet", "--no-save"])
    .interactive(false)
    .signal_handlers(false)
    .init()?;

Fields§

§args: Vec<String>§interactive: bool§signal_handlers: bool

Implementations§

Source §

impl REngineBuilder

Source

pub fn new() -> Self

Create a new R engine builder with default settings.

Source

pub fn with_args(self, args: &[&str]) -> Self

Set the command-line arguments for R initialization.

Default is ["R", "--quiet", "--vanilla"].

Source

pub fn interactive(self, interactive: bool) -> Self

Set whether R should run in interactive mode.

Default is false.

Source

pub fn signal_handlers(self, enable: bool) -> Self

Set whether R should install signal handlers.

Default is false. Set to true if you want R to handle Ctrl+C etc.

Source

pub unsafe fn init(self) -> Result<REngine, REngineError>

Initialize the R runtime with the configured settings.

§Safety

Must only be called once per process
Must be called from the main thread
R cannot be safely shutdown and reinitialized

§Errors

Returns an error if R initialization fails.

Trait Implementations§

Source §

impl Default for REngineBuilder

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for REngineBuilder

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> SizeHint for T
where T: ?Sized,

Source §

default fn lower_bound(&self) -> usize

🔬This is a nightly-only experimental API. (core_io_internals)

Returns a lower bound on the number of elements this container-like item contains. For example, an array [u8; 12] could return any value between 0 and 12 inclusively as a correct implementation. Read more

Source §

default fn upper_bound(&self) -> Option<usize>

🔬This is a nightly-only experimental API. (core_io_internals)

Returns an upper bound on the number of elements this container-like item contains if it can be determined, otherwise None. Read more

Source §

final fn size_hint(&self) -> (usize, Option<usize>)

🔬This is a nightly-only experimental API. (core_io_internals)

Returns an estimate for the number of elements this container like type contains. Read more

Source §