Struct mpi::request::Request

#[must_use]
pub struct Request<'a, S: Scope<'a>> { /* fields omitted */ }

A request object for a non-blocking operation registered with a Scope of lifetime 'a

The Scope is needed to ensure that all buffers associated request will outlive the request itself, even if the destructor of the request fails to run.

Panics

Panics if the request object is dropped. To prevent this, call wait, wait_without_status, or test. Alternatively, wrap the request inside a WaitGuard or CancelGuard.

Examples

See examples/immediate.rs

Standard section(s)

3.7.1

Methods

impl<'a, S: Scope<'a>> Request<'a, S>

pub unsafe fn from_raw(request: MPI_Request, scope: S) -> Self

Construct a request object from the raw MPI type.

Requirements

• The request is a valid, active request. It must not be MPI_REQUEST_NULL.
• The request must not be persistent.
• All buffers associated with the request must outlive 'a.
• The request must not be registered with the given scope.

pub unsafe fn into_raw(self) -> (MPI_Request, S)

Unregister the request object from its scope and deconstruct it into its raw parts.

This is unsafe because the request may outlive its associated buffers.

pub fn wait(self) -> Status

Wait for an operation to finish.

Will block execution of the calling thread until the associated operation has finished.

Examples

See examples/immediate.rs

Standard section(s)

3.7.3

pub fn wait_without_status(self)

Wait for an operation to finish, but don’t bother retrieving the Status information.

Will block execution of the calling thread until the associated operation has finished.

Standard section(s)

3.7.3

pub fn test(self) -> Result<Status, Self>

Test whether an operation has finished.

If the operation has finished, Status is returned. Otherwise returns the unfinished Request.

Examples

See examples/immediate.rs

Standard section(s)

3.7.3

pub fn cancel(&self)

Initiate cancellation of the request.

The MPI implementation is not guaranteed to fulfill this operation. It may not even be valid for certain types of requests. In the future, the MPI forum may deprecate cancellation of sends entirely.

Examples

See examples/immediate.rs

Standard section(s)

3.8.4

pub fn shrink_scope_to<'b, S2>(self, scope: S2) -> Request<'b, S2> where
    'a: 'b,
    S2: Scope<'b>, 

Reduce the scope of a request.

Trait Implementations

impl<'a, S: Debug + Scope<'a>> Debug for Request<'a, S>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a, S: Scope<'a>> AsRaw for Request<'a, S>

type Raw = MPI_Request

The raw MPI C API type

fn as_raw(&self) -> Self::Raw

The raw value

impl<'a, S: Scope<'a>> Drop for Request<'a, S>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, S: Scope<'a>> From<WaitGuard<'a, S>> for Request<'a, S>

fn from(guard: WaitGuard<'a, S>) -> Self

Performs the conversion.

impl<'a, S: Scope<'a>> From<Request<'a, S>> for WaitGuard<'a, S>

fn from(req: Request<'a, S>) -> Self

Performs the conversion.

impl<'a, S: Scope<'a>> From<Request<'a, S>> for CancelGuard<'a, S>

fn from(req: Request<'a, S>) -> Self

Performs the conversion.