Struct RefCellComputeChannel

pub struct RefCellComputeChannel<Server> { /* private fields */ }

A channel using a ref cell to access the server with mutability.

Important

Only use this channel if you don’t use any threading in your application, otherwise it will panic or cause undefined behaviors.

This is mosly useful for no-std environments where threads aren’t supported, otherwise prefer the mutex or the mpsc channels.

Implementations

impl<Server> RefCellComputeChannel<Server>

where Server: ComputeServer,

pub fn new(server: Server) -> Self

Create a new cell compute channel.

Trait Implementations

impl<S> Clone for RefCellComputeChannel<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Server> ComputeChannel<Server> for RefCellComputeChannel<Server>

where Server: ComputeServer + Send,

async fn read(&self, bindings: Vec<Binding>) -> Vec<Vec<u8>>

Given bindings, returns owned resources as bytes

async fn read_tensor(&self, bindings: Vec<BindingWithMeta>) -> Vec<Vec<u8>>

Given bindings, returns owned resources as bytes

fn get_resource( &self, binding: Binding, ) -> BindingResource<<Server::Storage as ComputeStorage>::Resource>

Given a resource handle, return the storage resource.

fn create(&self, resource: &[u8]) -> Handle

Given a resource as bytes, stores it and returns the resource handle

fn create_tensor( &self, data: &[u8], shape: &[usize], elem_size: usize, ) -> (Handle, Vec<usize>)

Given a resource as bytes and a shape, stores it and returns the tensor handle

fn empty(&self, size: usize) -> Handle

Reserves size bytes in the storage, and returns a handle over them

fn empty_tensor( &self, shape: &[usize], elem_size: usize, ) -> (Handle, Vec<usize>)

Reserves a tensor with shape in the storage, and returns a handle to it

unsafe fn execute( &self, kernel_description: Server::Kernel, count: CubeCount, bindings: Bindings, kind: ExecutionMode, )

Executes the kernel over the given bindings.

fn flush(&self)

Flush outstanding work of the server.

async fn sync(&self)

Wait for the completion of every task in the server.

fn memory_usage(&self) -> MemoryUsage

Get the current memory usage of the server.

fn memory_cleanup(&self)

Ask the server to release memory that it can release.

fn start_profile(&self)

Start a profile on the server. This allows you to profile kernels.

fn end_profile(&self) -> ProfileDuration

End the profile and return a ProfileDuration.

impl<Server: Debug> Debug for RefCellComputeChannel<Server>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Server: ComputeServer> Send for RefCellComputeChannel<Server>

This is unsafe, since no concurrency is supported by the RefCell channel. However using this channel should only be done in single threaded environments such as no-std.

impl<Server: ComputeServer> Sync for RefCellComputeChannel<Server>