Task.FromResult() method in C#

in C#, the Task Parallel Library (TPL) in the .NET framework offers a method called Task.FromResult(). It gives programmers the ability to create a task that has already been finished and produces a desired outcome. For asynchronous programming scenarios, where it may be necessary to combine synchronous and asynchronous code, this approach is especially helpful when you need to return a completed task synchronously.

Task.FromResult() is primarily used to create a task that represents an asynchronous operation that has already been finished and has a given outcome.

It is important that Task.FromResult() does not offer the advantages of asynchronous execution, so it is not advised to be used for CPU-bound or potentially thread-blocking operations.
Unit testers frequently utilize Task.FromResult() to replicate asynchronous behavior without requiring the overhead of asynchronous operations.

Syntax:

It has the following syntax:

The kind of result we need to wrap up with the finished task is called a TResult.
The value we need to assign to the task's outcome is called the result.

Example:

Let us take an example to illustrate the Task.FromResult() method in C#.

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        int value = 123;
        	
        // Create a completed task with the value 123
 Task<int> completedTask = Task.FromResult(value);        
        // Retrieve the result synchronously
        int result = await completedTask;
        
        Console.WriteLine("Result: " + result);
    }
}

Output:

Result: 123

Example Code:

Let us take another example to illustrate the Task.FromResult() method in C#.

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // Example 1: Creating a completed task with an integer result
        int value = 42;
        
        // Create a completed task with the value 42
        Task<int> completedTask = Task.FromResult(value);
        
        // Retrieve the result synchronously
        int result = await completedTask;
        
        Console.WriteLine("Example 1 Result: " + result);

        // Example 2: Creating a completed task with a string result
        string message = "Hello, world!";
        
        // Create a completed task with the string message
        Task<string> completedTaskString = Task.FromResult(message);
        
        // Retrieve the result synchronously
        string resultString = await completedTaskString;
        
        Console.WriteLine("Example 2 Result: " + resultString);
    }
}

Output:

Example 1 Result: 42
Example 2 Result: Hello, world!

Explanation:

The Task is used in Example 1 to create a completed task with an integer result (42).fromResult().
Task is used in Example 2 to create a completed task with a string result ("Hello, world!").fromResult().

Example 2:

Let us take another example to illustrate the Task.FromResult() method in C#.

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // result: Simulating an asynchronous operation to retrieve user data
        string userId = "10567482";
        
        // Simulate fetching user data asynchronously
        UserData userData = await GetUserAsync(userId);
        
        // Print user data
        Console.WriteLine("Result: User ID: " + userData.UserId + ", Username: " + userData.Username);
    }

    static async Task<UserData> GetUserAsync(string userId)
    {
        // Simulating a delay before fetching user data
        await Task.Delay(1000);
        
        // Simulate fetching user data from a database or external service
        UserData user = GetUserFromDatabase(userId);
        
        // Return the user data as a completed task
        return Task.FromResult(user).Result;
    }

    static UserData GetUserFromDatabase(string userId)
    {
        // Simulate retrieving user data from a database
        // In a real scenario, this method would query a database or an external service
        // Here, we're just returning a hardcoded user for demonstration purposes
        return new UserData
        {
            UserId = userId,
            Username = "Harsha"
        };
    }
}

class UserData
{
    public string UserId { get; set; }
    public string Username { get; set; }
}

Output:

Result: User ID: 10567482, Username: Harsha

Explanation:

In this example, the result shows how to simulate an asynchronous operation to use FromResult() to retrieve user data.
The GetUserAsync() method uses Task to simulate an asynchronous operation by delaying by one second.Delay(), followed by a synchronous user data fetch using GetUserFromDatabase().
In this case, GetUserFromDatabase() merely returns a hardcoded user for demonstration; otherwise, it resembles fetching user data from a database or an external service.
Next, using Task, the user data that was obtained from GetUserFromDatabase() is wrapped around a finished task.fromResult() and provided an asynchronous return.

Conclusion:

For creating completed tasks with specified results, C#'s Task.FromResult() method is a simple and effective solution. The ability to seamlessly bridge the gap between synchronous and asynchronous code makes this method especially useful in scenarios where integrating the two paradigms is required. Task.FromResult() can be used to simulate asynchronous operations with predefined outcomes, which is useful when working with cached or pre-computed data or when unit testing code because of its flexible and simple syntax. Nevertheless, since it may negate the advantages of asynchronous programming, care must be taken to ensure that Task.FromResult() is not misused for lengthy or blocking processes. Task.For asynchronous programming in the.NET framework, FromResult() is a useful tool that helps with clear and simple code design.

Next TopicThread pool in C#

← prev next →