Struct Module

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

Represents a compiled device kernel.

This struct wraps a FFI pointer to the C++ pxl::Module class. It provides methods for creating functions.

Implementations§

Source§

impl Module

Implementation of the Module struct.

Source

pub fn new(filename: &str) -> Self

Creates a new Module wrapper from a raw FFI pointer. This is called in runtime wrapper APIs requiring an actual Module object.

§Arguments
  • ptr - A raw pointer to the underlying FFI Module object.
§Safety

Caller must ensure that ptr is valid and remains valid for the lifetime of Module.

Source

pub fn get(&self) -> *mut Module

Returns a raw pointer to the underlying FFI Module object. This is called in runtime wrapper APIs requiring a raw pointer.

§Safety

Caller must ensure that FFI object is valid.

Source

pub fn create_function(&self, name: &str) -> Function

Creates a new Function object.

§Arguments
  • name - Name of the Function to be created.
§Returns

A new Function object.

§Safety

Caller must ensure that name is valid and corresponds to an actual function in the module.

§Example
let module = pxl::create_module("tests/mu_kernel.mubin");
let function = module.create_function("sort_with_ptr");

Auto Trait Implementations§

§

impl Freeze for Module

§

impl RefUnwindSafe for Module

§

impl !Send for Module

§

impl !Sync for Module

§

impl Unpin for Module

§

impl UnwindSafe for Module

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.