Parámetro predeterminado para CancellationToken

Tengo un código asincrónico al que me gustaría agregar un código CancellationToken. Sin embargo, hay muchas implementaciones en las que esto no es necesario, por lo que me gustaría tener un parámetro predeterminado, tal vez CancellationToken.None. Sin embargo,

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

rendimientos

Un valor de tipo '' no se puede usar como parámetro predeterminado porque no hay conversiones estándar para escribir 'System.Threading.CancellationToken'

y

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

El valor del parámetro predeterminado para 'ct' debe ser una constante en tiempo de compilación

¿Hay alguna forma de tener un valor predeterminado para CancellationToken?

Resulta que lo siguiente funciona:

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

que, según la documentación , se interpreta igual que CancellationToken.None:

También puede usar la default(CancellationToken)instrucción C # para crear un token de cancelación vacío.

¿Hay alguna forma de tener un valor predeterminado para CancellationToken?

Desafortunadamente, esto no es posible, ya CancellationToken.Noneque no es una constante de tiempo de compilación, que es un requisito para los valores predeterminados en los argumentos opcionales.

Sin embargo, puede proporcionar el mismo efecto si crea un método sobrecargado en lugar de intentar utilizar los parámetros predeterminados:

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

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

Aquí hay varias soluciones, en orden descendente de bondad general:

1. Usando default(CancellationToken)como valor predeterminado:

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

Semánticamente, CancellationToken.Nonesería el candidato ideal para el valor predeterminado, pero no se puede usar como tal porque no es una constante en tiempo de compilación. default(CancellationToken)es la mejor opción porque es una constante en tiempo de compilación y está oficialmente documentada como equivalente aCancellationToken.None .

2. Proporcionar una sobrecarga de método sin un CancellationTokenparámetro:

O, si prefiere las sobrecargas de métodos sobre los parámetros opcionales (consulte esta y esta pregunta sobre ese tema):

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

Para los métodos de interfaz, se puede lograr lo mismo utilizando métodos de extensión:

interface IFoo
{
    Task DoAsync(CancellationToken ct);
}

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

Esto da como resultado una interfaz más delgada y evita que los implementadores escriban explícitamente la sobrecarga del método de reenvío.

3. Hacer que el parámetro sea anulable y usar nullcomo valor predeterminado:

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

Me gusta esta solución menos porque los tipos que aceptan valores NULL vienen con una pequeña sobrecarga de tiempo de ejecución, y las referencias al token de cancelación se vuelven más detalladas debido al operador de fusión nulo ??.

Otra opción es usar un Nullable<CancellationToken>parámetro, establecerlo por defecto nully tratarlo dentro del método:

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

Las versiones más recientes de C # permiten una sintaxis simplificada para la versión predeterminada (CancellationToken). P.ej:

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

La respuesta de Tofutim es unidireccional, pero por los comentarios veo que la gente tiene problemas con eso.

En ese caso, sugerí que uno puede tener un método de la siguiente manera:

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

y sobrecargarlo como:

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

Esto se compila porque CancellationToken.Noneno se requiere el valor de en el momento de la compilación.