Dagger.IdentifierWord (dagger v1.0.0-beta.19)

Copy Markdown View Source

One word of an identifier.

Summary

Functions

A unique identifier for this IdentifierWord.

The kind of word.

Trailing digits and/or a plural "s", in that order: SHA+"s", OAuth+"2", HTTP+"2s".

The dictionary entry this word matched, if any.

Standard spelling: "client" (WORD), "HTTP" (ACRONYM), "GitHub" (TERM).

Types

t()

@type t() :: %Dagger.IdentifierWord{client: term(), query_builder: term()}

Functions

id(identifier_word)

@spec id(t()) :: {:ok, String.t()} | {:error, term()}

A unique identifier for this IdentifierWord.

kind(identifier_word)

@spec kind(t()) :: {:ok, Dagger.IdentifierWordKind.t()} | {:error, term()}

The kind of word.

suffix(identifier_word)

@spec suffix(t()) :: {:ok, String.t()} | {:error, term()}

Trailing digits and/or a plural "s", in that order: SHA+"s", OAuth+"2", HTTP+"2s".

term(identifier_word)

@spec term(t()) :: {:ok, Dagger.NamingTerm.t() | nil} | {:error, term()}

The dictionary entry this word matched, if any.

text(identifier_word)

@spec text(t()) :: {:ok, String.t()} | {:error, term()}

Standard spelling: "client" (WORD), "HTTP" (ACRONYM), "GitHub" (TERM).