Crate nixl_sys

Crate nixl_sys 

Source
Expand description

Raw FFI bindings to the NIXL library

This crate provides low-level bindings to the NIXL C++ library. It is not meant to be used directly, but rather through the higher-level nixl crate.

Structs§

Agent
A NIXL agent that can create backends and manage memory
AgentConfig
Backend
A NIXL backend that can be used for data transfer
MemList
A safe wrapper around NIXL memory list
MemListIterator
An iterator over memory types in a MemList
NotificationIterator
An iterator over notifications for a specific agent
NotificationMap
A safe wrapper around NIXL notification map
NotificationMapAgentIterator
An iterator over agent names in a NotificationMap
OptArgs
A safe wrapper around NIXL optional arguments
ParamIntoIter
An infallible iterator over parameter key-value pairs (filters out errors)
ParamIterator
An iterator over parameter key-value pairs
ParamPair
A key-value pair in the parameters
Params
A safe wrapper around NIXL parameters
QueryResponse
Represents a single query response which may or may not contain parameters
QueryResponseIterator
An iterator over query responses
QueryResponseList
A safe wrapper around a NIXL query response list
RegDescList
A safe wrapper around a NIXL registration descriptor list
RegDescriptor
Public registration descriptor used for indexing and comparisons
RegistrationHandle
StringList
A safe wrapper around a list of strings from NIXL
StringListIterator
An iterator over the strings in a StringList
SyncManager
Manager that enforces correct synchronization between frontend and backend
SystemStorage
System memory storage implementation using a Vec
XferDescList
A safe wrapper around a NIXL transfer descriptor list
XferDescriptor
Public transfer descriptor used for indexing and comparisons
XferDlistHandle
XferRequest
A handle to a transfer request
XferTelemetry
Transfer telemetry data wrapper

Enums§

CostMethod
Methods used for estimating transfer costs
MemType
Memory types supported by NIXL
NixlError
Errors that can occur when using NIXL
ThreadSync
XferOp
XferStatus

Constants§

NIXL_CAPI_ERROR_BACKEND
NIXL_CAPI_ERROR_INVALID_PARAM
NIXL_CAPI_ERROR_NO_TELEMETRY
NIXL_CAPI_IN_PROG
NIXL_CAPI_SUCCESS

Traits§

BackendSyncable
Trait for types that can synchronize their state to a backend
MemoryRegion
A trait for storage types that can be used with NIXL
NixlDescriptor
A trait for types that can be added to NIXL descriptor lists
NixlRegistration
A trait for types that can be registered with NIXL

Functions§

is_stub