Suppress warning CS1998: This async method lacks 'await'

Question

I've got an interface with some functions that return Task. Some of the classes that implement the interface do not have anything to await, while others might just throw - so the warnings are spurious and annoying.

Is it possible to suppress these warnings? E.g.:

public async Task<object> test() {     throw new NotImplementedException(); } 

yields:

warning CS1998: This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.

Answer 1

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.