Nameof

Artigo
04/07/2023

A expressão nameof produz uma constante de cadeia de caracteres que corresponde ao nome na origem de quase qualquer construção F# na origem.

Sintaxe

nameof symbol
nameof<'TGeneric>

Comentários

nameof funciona resolvendo o símbolo passado para ele e produz o nome desse símbolo conforme ele é declarado em seu código-fonte. Isso é útil em vários cenários, como registrar em log, além de proteger seu registro em log contra alterações no código-fonte.

let months =
    [
        "January"; "February"; "March"; "April";
        "May"; "June"; "July"; "August"; "September";
        "October"; "November"; "December"
    ]

let lookupMonth month =
    if (month > 12 || month < 1) then
        invalidArg (nameof month) ($"Value passed in was %d{month}.")

    months[month-1]

printfn "%s" (lookupMonth 12)
printfn "%s" (lookupMonth 1)
printfn "%s" (lookupMonth 13)

A última linha gerará uma exceção e "month" será mostrado na mensagem de erro.

Você pode usar um nome de quase todo o constructo F#:

module M =
    let f x = nameof x

printfn $"{(M.f 12)}"
printfn $"{(nameof M)}"
printfn $"{(nameof M.f)}"

nameof não é uma função de primeira classe e não pode ser usado como tal. Isso significa que ele não pode ser parcialmente aplicado e os valores não podem ser redirecionados para ele por meio de operadores de pipeline F#.

Nameof em operadores

Os operadores em F# podem ser usados de duas maneiras: como um próprio texto do operador ou um símbolo que representa o formulário compilado. nameof em um operador produzirá o nome do operador como ele é declarado na origem. Para obter o nome compilado, use o nome compilado na origem:

nameof(+) // "+"
nameof op_Addition // "op_Addition"

Nameof em genéricos

Também é possível usar um nome de um parâmetro de tipo genérico, mas a sintaxe é diferente:

let f<'a> () = nameof<'a>
f() // "a"

nameof<'TGeneric> usará o nome do símbolo conforme definido na origem, e não o nome do tipo substituído em um site de chamada.

O motivo pelo qual a sintaxe é diferente é para alinhar-se com outros operadores intrínsecos F# como typeof<> e typedefof<>. Isso torna o F# consistente em relação aos operadores que atuam em tipos genéricos e qualquer outra coisa na origem.

Nameof em padrões correspondentes

O padrão nameof permite que você use nameof em uma expressão de correspondência de padrão da seguinte maneira:

let f (str: string) =
    match str with
    | nameof str -> "It's 'str'!"
    | _ -> "It is not 'str'!"

f "str" // matches
f "asdf" // does not match

Nameof com membros de instância

F# requer uma instância para extrair o nome de um membro de instância com nameof. Se uma instância não estiver imediatamente disponível, uma instância poderá ser obtida usando Unchecked.defaultof.

type MyRecord = { MyField: int }
type MyClass() =
    member _.MyProperty = ()
    member _.MyMethod () = ()

nameof Unchecked.defaultof<MyRecord>.MyField   // MyField
nameof Unchecked.defaultof<MyClass>.MyProperty // MyProperty
nameof Unchecked.defaultof<MyClass>.MyMethod   // MyMethod

Compartilhar via