Uni20
Asynchronous tensor and runtime library.
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
uni20::async::ReadMaybeAwaiter< T const & > Class Template Reference

Awaiter returning pointer-or-null read access for lvalue buffers. More...

#include <buffers.hpp>

Public Types

using value_type = T const *
 

Public Member Functions

bool await_ready () const noexcept
 Check if the value is already ready to be read.
 
value_type await_resume ()
 Resume execution and return a pointer to stored value, or nullptr.
 
void await_suspend (BasicTask &&t) noexcept
 Suspend this coroutine and enqueue for resumption.
 
 ReadMaybeAwaiter (ReadMaybeAwaiter &&)=default
 Move constructor.
 

Detailed Description

template<typename T>
class uni20::async::ReadMaybeAwaiter< T const & >

Awaiter returning pointer-or-null read access for lvalue buffers.

Template Parameters
TStored value type.

Member Typedef Documentation

◆ value_type

template<typename T >
using uni20::async::ReadMaybeAwaiter< T const & >::value_type = T const*

Constructor & Destructor Documentation

◆ ReadMaybeAwaiter()

template<typename T >
uni20::async::ReadMaybeAwaiter< T const & >::ReadMaybeAwaiter ( ReadMaybeAwaiter< T const & > &&  )
default

Move constructor.

Member Function Documentation

◆ await_ready()

template<typename T >
bool uni20::async::ReadMaybeAwaiter< T const & >::await_ready ( ) const
inlinenoexcept

Check if the value is already ready to be read.

Returns
True if the epoch is ready and no suspension is needed.

◆ await_resume()

template<typename T >
value_type uni20::async::ReadMaybeAwaiter< T const & >::await_resume ( )
inline

Resume execution and return a pointer to stored value, or nullptr.

◆ await_suspend()

template<typename T >
void uni20::async::ReadMaybeAwaiter< T const & >::await_suspend ( BasicTask &&  t)
inlinenoexcept

Suspend this coroutine and enqueue for resumption.

Parameters
tCoroutine task to enqueue.

The documentation for this class was generated from the following file: