URN (URN v1.0.0) View Source

Uniform Resource Name tooling.

URNs are a smaller subset of URIs. Both share a scheme and the same encoding directives.

For more indepth knowledge about what a URN is, check out RFC8141.

Link to this section Summary

reason()

t()

Checks if two URNs are equal.

Parses a urn string into it's various parts.

reason() :: String.t() | term()

t() :: %URN{
  fragment: term(),
  nid: term(),
  nss: term(),
  query: term(),
  resolution: term()
}

Checks if two URNs are equal.

Something to note, when comparing URNs, resolution, query, and fragments are ignored. This is outlined in the spec.

new(String.t(), String.t(), []) :: t() | {:error, reason()}

parse(String.t()) :: {:ok, t()} | {:reason, reason()}

Parses a urn string into it's various parts.

{:ok, urn} = URN.parse("urn:example:a123,z456?+abc")

parse!(String.t()) :: t()

to_string(t()) :: String.t()