Struct MclEnvBuilder

Source
pub struct MclEnvBuilder { /* private fields */ }
Expand description

This structure is used to setup the MCL environment with the given parameters

§Examples

 use mcl_rs::MclEnvBuilder;

 let env = MclEnvBuilder::new()
                 .num_workers(10)
                 .bind_workers()
                 .initialize();

Implementations§

Source§

impl MclEnvBuilder

Source

pub fn new() -> MclEnvBuilder

Creates and returns a new MclEnvBuilder with the default values

§Examples
 use mcl_rs::MclEnvBuilder;

 let env = MclEnvBuilder::new()
                 .initialize();
Source

pub fn num_workers(self, workers: usize) -> MclEnvBuilder

Set the num_workers to pass to the mcl initialization function

§Examples
 use mcl_rs::MclEnvBuilder;

 let env = MclEnvBuilder::new()
                 .num_workers(1);
Source

pub fn bind_workers(self) -> MclEnvBuilder

Bind worker threads to their own core

§Examples
 use mcl_rs::MclEnvBuilder;

 let env = MclEnvBuilder::new()
                 .bind_workers();
Source

pub fn initialize(self) -> Mcl

Initializes mcl

Returns an Mcl instance

§Examples
 use mcl_rs::MclEnvBuilder;

 let env = MclEnvBuilder::new()
                 .initialize();

Auto Trait Implementations§

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<U> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.