Параметр за замовчуванням для CancellationToken

У мене є асинхронний код, до якого я хотів би додати a CancellationToken. Однак є багато реалізацій, де це не потрібно, тому я хотів би мати параметр за замовчуванням - можливо CancellationToken.None. Однак

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

врожайність

Значення типу '' не можна використовувати як параметр за замовчуванням, оскільки немає стандартних перетворень типу 'System.Threading.CancellationToken'

і

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

Значення параметра за замовчуванням для 'ct' має бути константою часу компіляції

Чи є спосіб отримати значення за замовчуванням CancellationToken?

Виявляється, працює наступне:

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

що, згідно з документацією , трактується так само, як CancellationToken.None:

Ви також можете використовувати default(CancellationToken)оператор C #, щоб створити порожній маркер скасування.

Чи є спосіб отримати значення за замовчуванням для 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параметра:

Або, якщо ви віддаєте перевагу перевантаженню методів над необов’язковими параметрами (див. Це та це питання на цю тему):

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як значення за замовчуванням:

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

Мені це рішення подобається найменше тому, що типи, що допускають обнулення, мають невеликі накладні витрати на виконання, а посилання на маркер скасування стають більш багатослівними через нульовий оператор злиття ??.

Інший варіант - використовувати Nullable<CancellationToken>параметр, встановити його за замовчуванням nullі мати справу з ним усередині методу:

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

Новіші версії C # дозволяють спростити синтаксис для типової версії (CancellationToken). Наприклад:

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

Відповідь Тофутіма є одним із шляхів, але з коментарів я бачу, що люди мають проблеми з цим.

У цьому випадку я припустив, що можна використовувати такий спосіб:

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

і перевантажте його як:

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

Це компілюється, оскільки значення часу CancellationToken.Noneне потрібно під час компіляції.