Struct async_rdma::LocalMr

pub struct LocalMr { /* private fields */ }

Local Memory Region

Implementations

impl LocalMr

pub fn get(&self, i: Range<usize>) -> Option<LocalMrSlice<'_>>

Get a local mr slice

Return None if the inputed range is wrong

pub unsafe fn get_unchecked(&self, i: Range<usize>) -> LocalMrSlice<'_>

Get an unchecked local mr slice

Safety

Callers of this function are responsible that these preconditions are satisfied:

• The starting index must not exceed the ending index;
• Indexes must be within bounds of the original LocalMr.

pub fn get_mut(&mut self, i: Range<usize>) -> Option<LocalMrSliceMut<'_>>

Get a mutable local mr slice

Return None if the inputed range is wrong

pub unsafe fn get_unchecked_mut(
    &mut self,
    i: Range<usize>
) -> LocalMrSliceMut<'_>

Get an unchecked mutable local mr slice

Safety

Callers of this function are responsible that these preconditions are satisfied:

• The starting index must not exceed the ending index;
• Indexes must be within bounds of the original LocalMr.

Trait Implementations

impl Debug for LocalMr

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

Formats the value using the given formatter.

impl LocalMrReadAccess for &LocalMr

fn lkey(&self) -> u32

Get the local key

fn get_inner(&self) -> &Arc<RwLock<LocalMrInner>>

Get the corresponding RwLocalMrInner

fn as_ptr(&self) -> MappedRwLockReadGuard<'_, *const u8>

Get the start pointer until it is readable

fn try_as_ptr(&self) -> Option<MappedRwLockReadGuard<'_, *const u8>>

Try to get the start pointer

fn as_ptr_unchecked(&self) -> *const u8

Get the start pointer without lock

fn as_slice(&self) -> MappedRwLockReadGuard<'_, &[u8]>

Get the memory region as slice until it is readable

fn try_as_slice(&self) -> Option<MappedRwLockReadGuard<'_, &[u8]>>

Try to get the memory region as slice

unsafe fn as_slice_unchecked(&self) -> &[u8]

Get the memory region as slice without lock

unsafe fn lkey_unchecked(&self) -> u32

Get the local key without lock

unsafe fn rkey_unchecked(&self) -> u32

Get the remote key without lock

fn token_with_timeout(&self, timeout: Duration) -> Option<MrToken>

New a token with specified timeout

unsafe fn token_with_timeout_unchecked(
    &self,
    timeout: Duration
) -> Option<MrToken>

New a token with specified timeout with rkey_unchecked

fn is_readable(&self) -> bool

Is the corresponding RwLocalMrInner readable?

fn read_inner(&self) -> RwLockReadGuard<'_, LocalMrInner>

Get read lock of LocalMrInenr

impl LocalMrReadAccess for LocalMr

fn lkey(&self) -> u32

Get the local key

fn get_inner(&self) -> &Arc<RwLock<LocalMrInner>>

Get the corresponding RwLocalMrInner

fn as_ptr(&self) -> MappedRwLockReadGuard<'_, *const u8>

Get the start pointer until it is readable

fn try_as_ptr(&self) -> Option<MappedRwLockReadGuard<'_, *const u8>>

Try to get the start pointer

fn as_ptr_unchecked(&self) -> *const u8

Get the start pointer without lock

fn as_slice(&self) -> MappedRwLockReadGuard<'_, &[u8]>

Get the memory region as slice until it is readable

fn try_as_slice(&self) -> Option<MappedRwLockReadGuard<'_, &[u8]>>

Try to get the memory region as slice

unsafe fn as_slice_unchecked(&self) -> &[u8]

Get the memory region as slice without lock

unsafe fn lkey_unchecked(&self) -> u32

Get the local key without lock

unsafe fn rkey_unchecked(&self) -> u32

Get the remote key without lock

fn token_with_timeout(&self, timeout: Duration) -> Option<MrToken>

New a token with specified timeout

unsafe fn token_with_timeout_unchecked(
    &self,
    timeout: Duration
) -> Option<MrToken>

New a token with specified timeout with rkey_unchecked

fn is_readable(&self) -> bool

Is the corresponding RwLocalMrInner readable?

fn read_inner(&self) -> RwLockReadGuard<'_, LocalMrInner>

Get read lock of LocalMrInenr

impl LocalMrWriteAccess for LocalMr

fn as_mut_ptr(&mut self) -> MappedRwLockWriteGuard<'_, *mut u8>

Get the mutable start pointer until it is writeable

fn try_as_mut_ptr(&self) -> Option<MappedRwLockWriteGuard<'_, *mut u8>>

Try to get the mutable start pointer

fn as_mut_ptr_unchecked(&mut self) -> *mut u8

Get the memory region start mut addr without lock

fn as_mut_slice(&mut self) -> MappedRwLockWriteGuard<'_, &mut [u8]>

Get the memory region as mutable slice until it is writeable

fn try_as_mut_slice(&mut self) -> Option<MappedRwLockWriteGuard<'_, &mut [u8]>>

Try to get the memory region as mutable slice

unsafe fn as_mut_slice_unchecked(&mut self) -> &mut [u8]

Get the memory region as mut slice without lock

fn is_writeable(&self) -> bool

Is the corresponding RwLocalMrInner writeable?

fn write_inner(&self) -> RwLockWriteGuard<'_, LocalMrInner>

Get write lock of LocalMrInenr

impl MrAccess for &LocalMr

fn addr(&self) -> usize

Get the start addr

fn length(&self) -> usize

Get the length

fn rkey(&self) -> u32

Get the remote key

fn access(&self) -> BitFlags<AccessFlag>

Get the BitFlags<AccessFlag> of mr

impl MrAccess for LocalMr

fn addr(&self) -> usize

Get the start addr

fn length(&self) -> usize

Get the length

fn rkey(&self) -> u32

Get the remote key

fn access(&self) -> BitFlags<AccessFlag>

Get the BitFlags<AccessFlag> of mr