Struct TransferOptions 

pub struct TransferOptions {
    pub layer_range: Option<Range<usize>>,
    pub nixl_write_notification: Option<u64>,
    pub bounce_buffer: Option<BounceBuffer>,
    pub cuda_stream: Option<Arc<CudaStream>>,
    pub src_kv_layout: Option<KvBlockLayout>,
    pub dst_kv_layout: Option<KvBlockLayout>,
}

Options for configuring transfer operations.

This structure provides configuration for block and layer transfers, including layer ranges, NIXL write notifications, and bounce buffers.

Examples

let options = TransferOptions::builder()
    .nixl_write_notification(42)
    .layer_range(0..10)
    .build();

Fields

layer_range: Option<Range<usize>>

Range of layers to transfer (None = all layers).

When specified, only the layers in this range will be transferred. This is useful for partial block transfers or layer-specific operations.

nixl_write_notification: Option<u64>

NIXL write notification value delivered after RDMA write completes.

When specified, NIXL will deliver this notification value to the remote node after the RDMA write operation completes. This enables efficient notification of transfer completion without requiring polling.

bounce_buffer: Option<BounceBuffer>

Bounce buffer specification for multi-hop transfers.

When direct transfers are not allowed or efficient, this specifies an intermediate staging area. The transfer will be split into two hops: source → bounce buffer → destination.

cuda_stream: Option<Arc<CudaStream>>

Optional caller-provided CUDA stream for the transfer.

When provided, the transfer executor will use this stream instead of acquiring one from the pool. The caller is responsible for synchronization - no event is recorded by the executor.

This is useful for layer-wise transfers where all layers must execute on the same stream to allow proper event sequencing.

src_kv_layout: Option<KvBlockLayout>

Override source block layout interpretation.

When set, the transfer executor will treat source blocks as having this layout instead of the layout’s default block_layout(). This enables transferring blocks that are stored in one format but should be interpreted as another (e.g., operational → universal).

dst_kv_layout: Option<KvBlockLayout>

Override destination block layout interpretation.

When set, the transfer executor will treat destination blocks as having this layout instead of the layout’s default block_layout(). This enables writing blocks in a different format than the destination layout’s native format.

Implementations

impl TransferOptions

Auto-generated by derive_getters::Dissolve.

pub fn dissolve( self, ) -> (Option<Range<usize>>, Option<u64>, Option<BounceBuffer>, Option<Arc<CudaStream>>, Option<KvBlockLayout>, Option<KvBlockLayout>)

Dissolve TransferOptions into a tuple consisting of its fields in order of declaration.

impl TransferOptions

pub fn builder() -> TransferOptionsBuilder

Create a new builder for transfer options.

pub fn from_layer_range(layer_range: Option<Range<usize>>) -> Self

Create transfer options from an optional layer range.

pub fn new() -> Self

Create default transfer options.

This transfers all layers with no special configuration.

Trait Implementations

impl Clone for TransferOptions

fn clone(&self) -> TransferOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TransferOptions

fn default() -> TransferOptions

Returns the “default value” for a type.