Struct mpi::request::RequestCollection

pub struct RequestCollection<'a, D: ?Sized> { /* private fields */ }

Request collection for managing multiple requests at the same time.

Implementations

impl<'a, D: ?Sized> RequestCollection<'a, D>

pub fn incomplete(&self) -> usize

Return the total number of requests that are incomplete.

pub fn add<S>(&mut self, req: Request<'a, D, S>) -> usize

where S: Scope<'a>,

Add the request to the collection. This unregisters the request from the scope. The collection then ensures that the request has completed.

pub fn wait_any(&mut self) -> Option<(usize, Status, &'a D)>

Wait for any request to complete, and return an option containing (request_index, status, saved_data).

pub fn wait_some(&mut self, result: &mut Vec<(usize, Status, &'a D)>)

Wait for some of the requests to complete, fill result with references to the (request_index, status, saved_data) for each completed request and return the total number of completed requests.

pub fn wait_all(&mut self, result: &mut Vec<(usize, Status, &'a D)>)

Wait for all requests to complete, putting (request_index, status, saved_data) into result for every completed request.

pub fn test_any(&mut self) -> Option<(usize, Status, &'a D)>

Test for the completion of any requests. Returns an option containing (request_index, status, saved_data).

pub fn test_some(&mut self, result: &mut Vec<(usize, Status, &'a D)>)

Test for the completion of some requests. Completed request data will be stored in the result buffer in a tuple (request_index, status, saved_data).

pub fn test_all(&mut self, result: &mut Vec<(usize, Status, &'a D)>) -> bool

Test for the completion of all requests. Saved data used by the completed requests is stored in the result buffer.

Trait Implementations

impl<'a, D: ?Sized> Drop for RequestCollection<'a, D>

Drop implementation to ensure that all requests have actually completed.

fn drop(&mut self)

Executes the destructor for this type.