VcfDeserializeAsync(FuncCancellationToken, TaskStream, Encoding, CancellationToken) Method

Deserializes a Stream of VCF data in an asynchronous operation.

Definition

Namespace: FolkerKinzel.VCards
Assembly: FolkerKinzel.VCards (in FolkerKinzel.VCards.dll) Version: 8.2.0+a3997783578d19ef70b23d32085936c13ed21656

C#

public static Task<IReadOnlyList<VCard>> DeserializeAsync(
	Func<CancellationToken, Task<Stream>> factory,
	Encoding? textEncoding = null,
	CancellationToken token = default
)

VB

Public Shared Function DeserializeAsync ( 
	factory As Func(Of CancellationToken, Task(Of Stream)),
	Optional textEncoding As Encoding = Nothing,
	Optional token As CancellationToken = Nothing
) As Task(Of IReadOnlyList(Of VCard))

C++

public:
static Task<IReadOnlyList<VCard^>^>^ DeserializeAsync(
	Func<CancellationToken, Task<Stream^>^>^ factory, 
	Encoding^ textEncoding = nullptr, 
	CancellationToken token = CancellationToken()
)

F#

static member DeserializeAsync : 
        factory : Func<CancellationToken, Task<Stream>> * 
        ?textEncoding : Encoding * 
        ?token : CancellationToken 
(* Defaults:
        let _textEncoding = defaultArg textEncoding null
        let _token = defaultArg token new CancellationToken()
*)
-> Task<IReadOnlyList<VCard>>

Parameters

factory FuncCancellationToken, TaskStream: A function that takes a CancellationToken as argument and returns a Stream of VCF data as an asynchronous operation.
textEncoding Encoding (Optional): The text encoding to use for deserialization or null, to deserialize the Stream with the standard-compliant text encoding UTF8.
token CancellationToken (Optional): A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value

TaskIReadOnlyListVCard
The task object representing the asynchronous operation.

Remarks

The Streams that is used within the method will be closed when the method completes.

Exceptions

ArgumentNullException	factory is null.
ArgumentException	The Stream that factory returns asynchronously doesn't support reading.
ObjectDisposedException	factory returns a closed stream.
IOException	The method could not read from the Stream.