Task.FromResult<TResult>(TResult) Метод

Определение

Пространство имен:

System.Threading.Tasks

Сборка:

System.Threading.Tasks.dll

Сборка:

System.Runtime.dll

Сборка:

mscorlib.dll

Сборка:

netstandard.dll

Создает Task<TResult>, которая завершается удачно с указанным результатом.

public:
generic <typename TResult>
 static System::Threading::Tasks::Task<TResult> ^ FromResult(TResult result);

public static System.Threading.Tasks.Task<TResult> FromResult<TResult> (TResult result);

static member FromResult : 'Result -> System.Threading.Tasks.Task<'Result>

Public Shared Function FromResult(Of TResult) (result As TResult) As Task(Of TResult)

Параметры типа

TResult

Тип результата, возвращенного задачей.

Параметры

result

TResult

Результат, сохраняемый в завершенную задачу.

Возвращаемое значение

Task<TResult>

Успешно завершенная задача.

Примеры

В следующем примере показана программа командной строки, которая вычисляет количество байтов в файлах в каждом каталоге, имя которого передается в качестве аргумента командной строки. Вместо выполнения более длинного пути кода, который FileStream создает экземпляр объекта и извлекает значение его FileStream.Length свойства для каждого файла в каталоге, в примере просто вызывается FromResult метод для создания задачи, свойство которой Task<TResult>.Result равно нулю (0), если каталог не имеет файлов.

using System;
using System.Collections.Generic;
using System.IO;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      string[] args = Environment.GetCommandLineArgs();
      if (args.Length > 1) {
         List<Task<long>> tasks = new List<Task<long>>();
         for (int ctr = 1; ctr < args.Length; ctr++)
            tasks.Add(GetFileLengthsAsync(args[ctr]));

         try {
            Task.WaitAll(tasks.ToArray());
         }
         // Ignore exceptions here.
         catch (AggregateException) {}

         for (int ctr = 0 ; ctr < tasks.Count; ctr++) {
            if (tasks[ctr].Status == TaskStatus.Faulted)
               Console.WriteLine("{0} does not exist", args[ctr + 1]);
            else
               Console.WriteLine("{0:N0} bytes in files in '{1}'",
                                 tasks[ctr].Result, args[ctr + 1]);
         }
      }
      else {
         Console.WriteLine("Syntax error: Include one or more file paths.");
      }
   }

   private static Task<long> GetFileLengthsAsync(string filePath)
   {
      if (! Directory.Exists(filePath)) {
         return Task.FromException<long>(
                     new DirectoryNotFoundException("Invalid directory name."));
      }
      else {
         string[] files = Directory.GetFiles(filePath);
         if (files.Length == 0)
            return Task.FromResult(0L);
         else
            return Task.Run( () => { long total = 0;
                                     Parallel.ForEach(files, (fileName) => {
                                                 var fs = new FileStream(fileName, FileMode.Open,
                                                                         FileAccess.Read, FileShare.ReadWrite,
                                                                         256, true);
                                                 long length = fs.Length;
                                                 Interlocked.Add(ref total, length);
                                                 fs.Close(); } );
                                     return total;
                                   } );
      }
   }
}
// When launched with the following command line arguments:
//      subdir . newsubdir
// the example displays output like the following:
//       0 bytes in files in 'subdir'
//       2,059 bytes in files in '.'
//       newsubdir does not exist

Imports System.Collections.Generic
Imports System.IO
Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim args() As String = Environment.GetCommandLineArgs()
      If args.Length > 1 Then
         Dim tasks As New List(Of Task(Of Long))
         For ctr = 1 To args.Length - 1
            tasks.Add(GetFileLengthsAsync(args(ctr)))
         Next
         Try
            Task.WaitAll(tasks.ToArray())
         ' Ignore exceptions here.
         Catch e As AggregateException
         End Try

         For ctr As Integer = 0 To tasks.Count - 1
            If tasks(ctr).Status = TaskStatus.Faulted Then
               Console.WriteLine("{0} does not exist", args(ctr + 1))
            Else
               Console.WriteLine("{0:N0} bytes in files in '{1}'",
                                 tasks(ctr).Result, args(ctr + 1))
            End If
         Next
      Else
         Console.WriteLine("Syntax error: Include one or more file paths.")
      End If
   End Sub
   
   Private Function GetFileLengthsAsync(filePath As String) As Task(Of Long)
      If Not Directory.Exists(filePath) Then
         Return Task.FromException(Of Long)(
                     New DirectoryNotFoundException("Invalid directory name."))
      Else
         Dim files As String() = Directory.GetFiles(filePath)
         If files.Length = 0 Then
            Return Task.FromResult(0L)
         Else
            Return Task.Run( Function()
                                Dim total As Long = 0
                                Dim lockObj As New Object
                                Parallel.ForEach(files, Sub(fileName)
                                                           Dim fs As New FileStream(fileName, FileMode.Open,
                                                                     FileAccess.Read, FileShare.ReadWrite,
                                                                     256, True)
                                                           Dim length As Long = fs.Length
                                                           Interlocked.Add(total, length)
                                                           fs.Close()
                                                        End Sub)
                                Return total
                             End Function )
         End If
      End If
   End Function
End Module
' When launched with the following command line arguments:
'      subdir . newsubdir
' the example displays output like the following:
'       0 bytes in files in 'subdir'
'       2,059 bytes in files in '.'
'       newsubdir does not exist

Комментарии

Этот метод создает Task<TResult> объект, свойство которого Task<TResult>.Result является result и свойство которого Status равно RanToCompletion. Этот метод обычно используется, когда возвращаемое значение задачи немедленно известно без выполнения более длинного пути к коду. Иллюстрация приведена в примере.

Чтобы создать Task объект, который не возвращает значение, извлеките Task объект из CompletedTask свойства.

Начиная с .NET 6, для некоторых T типов и некоторых результирующих значений этот метод может возвращать кэшированный одноэлементный объект, а не выделять новый объект.

См. также раздел

• CompletedTask