Struct Context 

pub struct Context { /* private fields */ }

A stateful cuSPARSE handle.

Use one context per host thread or concurrent task. The handle is movable between threads, but it is intentionally not Clone or Sync.

Implementations

impl Context

pub fn create(cuda_ctx: &Arc<CudaContext>) -> Result<Self>

Initializes the cuSPARSE library and creates a cuSPARSE handle. The handle must be created before using other cuSPARSE operations through this wrapper. It allocates hardware resources needed to access the GPU.

Errors

Returns an error if the CUDA context cannot be bound, if cuSPARSE cannot create a handle, or if cuSPARSE returns a null handle.

pub unsafe fn from_raw( handle: cusparseHandle_t, cuda_ctx: Arc<CudaContext>, ) -> Result<Self>

Wraps an existing cuSPARSE handle and takes ownership of it.

Safety

handle must be a valid cuSPARSE handle associated with cuda_ctx. Ownership of handle is transferred to the returned context, and the handle must not be destroyed elsewhere after calling this function.

pub fn cuda_context(&self) -> &Arc<CudaContext>

Returns the underlying CUDA context used by this cuSPARSE handle.

pub fn bind(&self) -> Result<()>

Binds the underlying CUDA context associated with this handle.

Errors

Returns an error if the CUDA context cannot be bound.

pub fn ensure_stream(&self, stream: &Stream) -> Result<()>

Ensures stream belongs to the same CUDA context as this handle.

Returns an error if the stream belongs to a different context.

pub fn version(&self) -> Result<i32>

Returns the version number of the cuSPARSE library.

Errors

Returns an error if the CUDA context cannot be bound or if cuSPARSE cannot report the version for this handle.

pub fn stream(&self) -> Result<StreamBinding>

Returns the stream used for cuSPARSE operations on this handle. If no explicit stream has been set, cuSPARSE uses the CUDA default stream.

Errors

Returns an error if the CUDA context cannot be bound or if cuSPARSE cannot report the current stream.

pub fn set_stream(&self, stream: Option<&Stream>) -> Result<()>

Sets the stream used by cuSPARSE operations on this handle.

Errors

Returns an error if stream belongs to another CUDA context, if the CUDA context cannot be bound, or if cuSPARSE rejects the stream.

pub fn scalar_pointer_mode(&self) -> Result<PointerMode>

Returns the context-global scalar pointer mode used by cuSPARSE operations on this handle. See PointerMode for scalar pointer semantics.

Errors

Returns an error if the CUDA context cannot be bound or if cuSPARSE cannot report the pointer mode.

pub fn set_scalar_pointer_mode(&self, mode: PointerMode) -> Result<()>

Sets the context-global scalar pointer mode used by cuSPARSE operations on this handle. The default mode reads scalar values from host memory. See PointerMode for scalar pointer semantics.

Errors

Returns an error if the CUDA context cannot be bound or if cuSPARSE rejects the pointer mode.

pub unsafe fn set_logger_callback( callback: cusparseLoggerCallback_t, ) -> Result<()>

Experimental: sets the logging callback function.

The callback must use the cuSPARSE logger callback ABI.

Safety

callback, if present, must remain valid for use by cuSPARSE and must follow the callback ABI expected by the library.

Errors

Returns an error if cuSPARSE rejects the callback.

pub fn set_logger_level(level: i32) -> Result<()>

Experimental: sets the logging level.

Errors

Returns an error if cuSPARSE rejects the logging level.

pub fn set_logger_mask(mask: i32) -> Result<()>

Experimental: sets the logging mask.

Errors

Returns an error if cuSPARSE rejects the logging mask.

pub unsafe fn set_logger_file(file: *mut FILE) -> Result<()>

Experimental: sets the logging output file. Once registered, the provided file handle must remain open until another file handle is registered.

Safety

file must be a valid FILE handle for as long as cuSPARSE may write to it.

Errors

Returns an error if cuSPARSE rejects the file handle.

pub fn set_logger_path(path: impl AsRef<Path>) -> Result<()>

Experimental: sets the logging output file by path.

Errors

Returns an error if path cannot be converted to a C string or if cuSPARSE cannot open the log file.

pub fn disable_logger() -> Result<()>

Disables cuSPARSE logging.

Errors

Returns an error if cuSPARSE cannot disable logging.

pub fn as_raw(&self) -> cusparseHandle_t

Returns the raw cuSPARSE handle.

The returned handle is borrowed and remains valid only while this context and its underlying CUDA context are alive.

pub fn into_raw(self) -> cusparseHandle_t

Consumes the context and returns the raw cuSPARSE handle without destroying it.

The caller becomes responsible for eventually destroying the returned handle with cuSPARSE.

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.