Параметр по умолчанию для CancellationToken

Оказывается, работает следующее:

Task<x> DoStuff(...., CancellationToken ct = default(CancellationToken))

...or:

Task<x> DoStuff(...., CancellationToken ct = default) // C# 7.1 and later

который, в соответствии с документация интерпретируется так же, как CancellationToken.None:

Вы также можете использовать оператор C # default(CancellationToken) для создания пустого токена отмены.

Есть ли способ иметь значение по умолчанию для CancellationToken?

К сожалению, это невозможно, поскольку CancellationToken.None не является константой времени компиляции, что является требованием для значений по умолчанию в дополнительных аргументах.

Однако вы можете добиться того же эффекта, создав перегруженный метод вместо того, чтобы пытаться использовать параметры по умолчанию:

Task<x> DoStuff(...., CancellationToken ct)
{
    //...
}

Task<x> DoStuff(....)
{
    return DoStuff(...., CancellationToken.None);
}

Вот несколько решений в порядке убывания их полезности:

1. Использование default(CancellationToken) в качестве значения по умолчанию:

Task DoAsync(CancellationToken ct = default(CancellationToken)) { … }

Семантически CancellationToken.None был бы идеальным кандидатом в качестве значения по умолчанию, но не может использоваться как таковой, потому что он не является константой времени компиляции. default(CancellationToken) - следующая лучшая вещь, потому что это константа времени компиляции и официально задокументировано как эквивалент CancellationToken.None.

2. Предоставление перегрузки метода без параметра CancellationToken:

Или, если вы предпочитаете перегрузку методов по необязательным параметрам (см. this и этот вопрос по этой теме):

Task DoAsync(CancellationToken ct) { … } // actual method always requires a token
Task DoAsync() => DoAsync(CancellationToken.None); // overload producing a default token

Для методов интерфейса то же самое можно сделать с помощью методов расширения:

interface IFoo
{
    Task DoAsync(CancellationToken ct);
}

static class Foo
{
    public static Task DoAsync(this IFoo foo) => foo.DoAsync(CancellationToken.None);
}

Это приводит к более тонкому интерфейсу и избавляет разработчиков от явного написания перегрузки метода пересылки.

3. Сделать параметр допускающим значение NULL и использовать null в качестве значения по умолчанию:

Task DoAsync(…, CancellationToken? ct = null)
{
    … ct ?? CancellationToken.None …
}

Мне нравится это решение хотя бы потому, что типы, допускающие значение NULL, связаны с небольшими накладными расходами во время выполнения, а ссылки на токен отмены становятся более подробными из-за оператора объединения с нулевым значением ??.

Другой вариант - использовать параметр Nullable<CancellationToken>, по умолчанию null и работать с ним внутри метода:

Task<x> DoStuff(...., CancellationToken? ct = null) {
    var token = ct ?? CancellationToken.None;
    ...
}

Более новые версии C # допускают упрощенный синтаксис для версии по умолчанию (CancellationToken). Например.:

Task<x> DoStuff(...., CancellationToken ct = default)