Packages
localize
0.37.0
1.0.0-rc.4
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.50.0
0.49.0
0.48.0
0.47.0
0.46.0
0.45.0
0.44.0
0.41.3
0.41.2
0.41.1
0.41.0
0.40.0
0.39.0
0.38.0
0.37.0
0.36.0
0.35.0
0.34.0
0.33.0
0.32.0
0.31.0
0.30.1
0.30.0
retired
0.29.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.1.0-alpha.1
Localization (parsing, formatting) of numbers, dates/time/calendar, units of measure, messages and lists. Includes localized collation.
Current section
Files
Jump to
Current section
Files
lib/localize/collation/insensitive.ex
defmodule Localize.Collation.Insensitive do
@moduledoc """
Case-insensitive string comparator for use with `Enum.sort/2`.
Implements the `compare/2` callback so this module can be passed directly
to `Enum.sort/2` as a comparator:
Enum.sort(strings, Localize.Collation.Insensitive)
Uses the NIF backend when available for maximum performance, otherwise
falls back to the pure Elixir implementation at secondary strength
(which ignores case distinctions).
"""
@doc """
Compare two strings in a case-insensitive manner.
### Arguments
* `string_a` - the first string to compare.
* `string_b` - the second string to compare.
### Returns
* `:lt` if `string_a` sorts before `string_b`.
* `:eq` if `string_a` and `string_b` are collation-equal (ignoring case).
* `:gt` if `string_a` sorts after `string_b`.
### Examples
iex> Localize.Collation.Insensitive.compare("a", "A")
:eq
iex> Localize.Collation.Insensitive.compare("b", "a")
:gt
"""
@spec compare(String.t(), String.t()) :: :lt | :eq | :gt
def compare(string_a, string_b) do
if Localize.Collation.Nif.available?() do
Localize.Collation.Nif.nif_compare(string_a, string_b, %Localize.Collation.Options{
strength: :secondary
})
else
Localize.Collation.compare(string_a, string_b, backend: :elixir, strength: :secondary)
end
end
end