Generator

Struct Generator 

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

Bindings generator.

This does:

  • Compile Futhark code to C code for each target.
  • Generate unsafe Rust bindings for each target.
  • Generate a single safe wrapper around all targets.
  • Compile and link generated C code.

§Usage

In your build.rs file:

use cargo_futhark::{Generator, Result, Target};

fn main() -> Result<()> {
    Generator::new("src/lib.fut")
        .with_target_if(Target::C, cfg!(feature = "c"))
        .with_target_if(Target::MultiCore, cfg!(feature = "multicore"))
        .with_target_if(Target::OpenCL, cfg!(feature = "opencl"))
        .with_target_if(Target::Cuda, cfg!(feature = "cuda"))
        .with_target_if(Target::ISPC, cfg!(feature = "ispc"))
        .run()
}

Implementations§

Source§

impl Generator

Source

pub fn new(source: impl Into<PathBuf>) -> Self

Returns a new Generator with default settings.

The source should be the .fut file containing the entry functions.

The defaults are:

  • watch_sources = true
  • targets = EMPTY

You must add at least on Target before you call Generator::run.

Source

pub fn watch_sources(&mut self, watch: bool) -> &mut Self

Watch Futhark source file for changes.

Enabled by default.

Source

pub fn with_cuda_home( &mut self, cuda_home: impl Into<PathBuf>, ) -> Result<&mut Self>

Specify a custom CUDA home path.

This will add the following:

  • $cuda_home/include to include path
  • $cuda_home/lib64 to link path
Source

pub fn with_target(&mut self, target: Target) -> &mut Self

Enable the given Target.

Source

pub fn with_target_if(&mut self, target: Target, condition: bool) -> &mut Self

Enable the given Target conditionally.

This is especially useful with the cfg! macro.

Source

pub fn run(&mut self) -> Result<()>

Run the generator.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.