Suppress warning CS1998: This async method lacks ‘await’

by

I’ve got an interface with some async functions.

Methods returning Task, I believe. async is an implementation detail, so it can’t be applied to interface methods.

Some of the classes that implements the interface does not have anything to await, and some might just throw.

In these cases, you can take advantage of the fact that async is an implementation detail.

If you have nothing to await, then you can just return Task.FromResult:

public Task<int> Success() // note: no "async"
{
  ... // non-awaiting code
  int result = ...;
  return Task.FromResult(result);
}

In the case of throwing NotImplementedException, the procedure is a bit more wordy:

public Task<int> Fail() // note: no "async"
{
  var tcs = new TaskCompletionSource<int>();
  tcs.SetException(new NotImplementedException());
  return tcs.Task;
}

If you have a lot of methods throwing NotImplementedException (which itself may indicate that some design-level refactoring would be good), then you could wrap up the wordiness into a helper class:

public static class TaskConstants<TResult>
{
  static TaskConstants()
  {
    var tcs = new TaskCompletionSource<TResult>();
    tcs.SetException(new NotImplementedException());
    NotImplemented = tcs.Task;
  }

  public static Task<TResult> NotImplemented { get; private set; }
}

public Task<int> Fail() // note: no "async"
{
  return TaskConstants<int>.NotImplemented;
}

The helper class also reduces garbage that the GC would otherwise have to collect, since each method with the same return type can share its Task and NotImplementedException objects.

I have several other “task constant” type examples in my AsyncEx library.

More Related Contents:

  1. How to limit the amount of concurrent async I/O operations?
  2. WaitAll vs WhenAll
  3. HttpClient.GetAsync(…) never returns when using await/async
  4. Running multiple async tasks and waiting for them all to complete
  5. Calling async method synchronously
  6. Entity Framework async operation takes ten times as long to complete
  7. Non-blocking file copy in C#
  8. Task sequencing and re-entracy
  9. Calling async methods from a WCF service
  10. How to wait for async method to complete?
  11. How does Task become an int?
  12. Is async/await suitable for methods that are both IO and CPU bound?
  13. Why does the async keyword exist
  14. What thread runs the code after the `await` keyword?
  15. Process files concurrently and asynchronously
  16. Are you there, asynchronously written value?
  17. Proper way to start and fire-and-forget asynchronous calls?
  18. What is the difference between using and await using? And how can I decide which one to use?
  19. Use Task.Run() in synchronous method to avoid deadlock waiting on async method?
  20. A pattern for self-cancelling and restarting task
  21. A pattern to pause/resume an async task?
  22. How can I capture the value of an outer variable inside a lambda expression?
  23. How to Async Files.ReadAllLines and await for results?
  24. Keep CurrentCulture in async/await
  25. How do I create a custom SynchronizationContext so that all continuations can be processed by my own single-threaded event loop?
  26. Is it possible to get successful results from a Task.WhenAll when one of the tasks fails? [duplicate]
  27. “Asynchronous operations are not allowed in this context”
  28. call async method without await #2
  29. Dns.BeginGetHost… methods blocking
  30. ConcurrentDictionary GetOrAdd async

Leave a Comment