IOExtensionsWriteTextAsync(Stream, ReadOnlyMemoryChar, Encoding, ActionStreamWriter, CancellationToken) - метод

Записывает текст в поток в указанной кодировке. Также записывает преамбулу (BOM) в соответствии с её наличием в кодировке encoding, что также определяется тем, что stream находится в нулевой позиции, или если он не сообщает свою позицию, т.е. CanSeek равно false (по этим же правилам работает StreamWriter).

Definition

Пространство имён: Tessa.Platform.IO
Сборка: Tessa (в Tessa.dll) Версия: 4.1.3+7e2b1422f9b8c7c41fbbc4b151a843bed05319ab
C#
public static ValueTask WriteTextAsync(
	this Stream stream,
	ReadOnlyMemory<char> text,
	Encoding? encoding = null,
	Action<StreamWriter>? configureWriterAction = null,
	CancellationToken cancellationToken = default
)

Параметры

stream  Stream
Поток, в который выполняется запись.
text  ReadOnlyMemoryChar
Записываемый текст.
encoding  Encoding  (Optional)

Кодировка или null, если используется кодировка по умолчанию - UTF-8 без BOM.

Если указать кодировку из статических свойств класса Encoding, например, UTF8, то такая кодировка использует BOM.

BOM будет записан, если stream находится в нулевой позиции, или если он не сообщает свою позицию, т.е. CanSeek равно false (по этим же правилам работает StreamWriter).

configureWriterAction  ActionStreamWriter  (Optional)

Действие, выполняющее конфигурацию объекта StreamWriter, используемого для записи текста, если этот объект будет создан (текст непустой), или null, если конфигурирование не требуется.

Используйте для инициализации свойств объекта, таких как NewLine.

cancellationToken  CancellationToken  (Optional)
Объект, посредством которого можно отменить асинхронную задачу.

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

ValueTask
Асинхронная задача.

Примечание об использовании

В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа Stream. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе Методы расширения (Visual Basic) или Методы расширения (Руководство по программированию в C#).

См. также