@ -549,9 +548,8 @@ pool to disconnect within the given interval.</p></div>
<h1class="section-heading">
<aclass="hover-link"href="#functions">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
</a>
Functions
</a>
</h1>
<divclass="functions-list">
<sectionclass="detail"id="aggregate/3">
@ -1116,23 +1114,23 @@ pool to disconnect within the given interval.</p><p>See <a href="https://hexdocs
<sectionclass="docstring">
<p>Similar to <ahref="#insert_all/2"><codeclass="inline">insert_all/2</code></a> but with the following differences:</p><ul><li>accepts rows as streams or lists</li><li>sends rows as a chunked request</li><li>doesn't autogenerate ids or does any other preprocessing</li></ul><p>Example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="nc">Repo</span><spanclass="o">.</span><spanclass="n">query!</span><spanclass="p"data-group-id="4231776152-1">(</span><spanclass="s">"create table ecto_ch_demo(a UInt64, b String) engine Null"</span><spanclass="p"data-group-id="4231776152-1">)</span><spanclass="w">
<p>Similar to <ahref="#insert_all/2"><codeclass="inline">insert_all/2</code></a> but with the following differences:</p><ul><li>accepts rows as streams or lists</li><li>sends rows as a chunked request</li><li>doesn't autogenerate ids or does any other preprocessing</li></ul><p>Example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="nc">Repo</span><spanclass="o">.</span><spanclass="n">query!</span><spanclass="p"data-group-id="7171128386-1">(</span><spanclass="s">"create table ecto_ch_demo(a UInt64, b String) engine Null"</span><spanclass="p"data-group-id="7171128386-1">)</span><spanclass="w">
the set of natural languages that are preferred as a response to the request.
Language tags function are provided in <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a>.</p><p>The format of an <codeclass="inline">Accept-Language</code> header is as follows in <codeclass="inline">ABNF</code> format:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="w"></span><spanclass="nc">Accept</span><spanclass="o">-</span><spanclass="nc">Language</span><spanclass="w"></span><spanclass="o">=</span><spanclass="w"></span><spanclass="s">"Accept-Language"</span><spanclass="w"></span><spanclass="s">":"</span><spanclass="w">
</span><spanclass="n">language</span><spanclass="o">-</span><spanclass="n">range</span><spanclass="w"></span><spanclass="o">=</span><spanclass="w"></span><spanclass="p"data-group-id="7462553449-1">(</span><spanclass="w"></span><spanclass="p"data-group-id="7462553449-2">(</span><spanclass="w"></span><spanclass="mi">1</span><spanclass="o">*</span><spanclass="mi">8</span><spanclass="nc">ALPHA</span><spanclass="w"></span><spanclass="o">*</span><spanclass="p"data-group-id="7462553449-3">(</span><spanclass="w"></span><spanclass="s">"-"</span><spanclass="w"></span><spanclass="mi">1</span><spanclass="o">*</span><spanclass="mi">8</span><spanclass="nc">ALPHA</span><spanclass="w"></span><spanclass="p"data-group-id="7462553449-3">)</span><spanclass="w"></span><spanclass="p"data-group-id="7462553449-2">)</span><spanclass="w"></span><spanclass="o">|</span><spanclass="w"></span><spanclass="s">"*"</span><spanclass="w"></span><spanclass="p"data-group-id="7462553449-1">)</span></code></pre><p>Each language-range MAY be given an associated quality value which represents an
</span><spanclass="n">language</span><spanclass="o">-</span><spanclass="n">range</span><spanclass="w"></span><spanclass="o">=</span><spanclass="w"></span><spanclass="p"data-group-id="7267430597-1">(</span><spanclass="w"></span><spanclass="p"data-group-id="7267430597-2">(</span><spanclass="w"></span><spanclass="mi">1</span><spanclass="o">*</span><spanclass="mi">8</span><spanclass="nc">ALPHA</span><spanclass="w"></span><spanclass="o">*</span><spanclass="p"data-group-id="7267430597-3">(</span><spanclass="w"></span><spanclass="s">"-"</span><spanclass="w"></span><spanclass="mi">1</span><spanclass="o">*</span><spanclass="mi">8</span><spanclass="nc">ALPHA</span><spanclass="w"></span><spanclass="p"data-group-id="7267430597-3">)</span><spanclass="w"></span><spanclass="p"data-group-id="7267430597-2">)</span><spanclass="w"></span><spanclass="o">|</span><spanclass="w"></span><spanclass="s">"*"</span><spanclass="w"></span><spanclass="p"data-group-id="7267430597-1">)</span></code></pre><p>Each language-range MAY be given an associated quality value which represents an
estimate of the user's preference for the languages specified by that range. The
quality value defaults to "q=1". For example,</p><pre><codeclass="makeup elixir"translate="no"><spanclass="w"></span><spanclass="nc">Accept</span><spanclass="o">-</span><spanclass="ss">Language</span><spanclass="p">:</span><spanclass="w"></span><spanclass="n">da</span><spanclass="p">,</span><spanclass="w"></span><spanclass="n">en</span><spanclass="o">-</span><spanclass="n">gb</span><spanclass="p">;</span><spanclass="n">q</span><spanclass="o">=</span><spanclass="mf">0.8</span><spanclass="p">,</span><spanclass="w"></span><spanclass="n">en</span><spanclass="p">;</span><spanclass="n">q</span><spanclass="o">=</span><spanclass="mf">0.7</span></code></pre><p>would mean: "I prefer Danish, but will accept British English and other types of English."</p>
</section>
@ -129,9 +129,8 @@ quality value defaults to "q=1". For example,</p><pre><code class="mak
<h1class="section-heading">
<aclass="hover-link"href="#summary">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
Summary
</a>
Summary
</h1>
<divclass="summary-functions summary">
<h2>
@ -183,9 +182,8 @@ in descending order.</p></div>
<h1class="section-heading">
<aclass="hover-link"href="#functions">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
</a>
Functions
</a>
</h1>
<divclass="functions-list">
<sectionclass="detail"id="best_match/1">
@ -217,71 +215,71 @@ Functions
<p>Parse an <codeclass="inline">Accept-Language</code> string and return the best match for
a configured <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html"><codeclass="inline">Cldr</code></a> locale.</p><h2id="best_match/1-arguments"class="section-heading">
<ul><li><codeclass="inline">accept_langauge</code> is a string representing an accept language header</li></ul><h2id="best_match/1-returns"class="section-heading">
</span><spanclass="s">"No configured locale could be matched to </span><spanclass="se">\"</span><spanclass="s">xx,yy;q=0.3</span><spanclass="se">\"</span><spanclass="s">"</span><spanclass="p"data-group-id="7670766303-21">}</span><spanclass="p"data-group-id="7670766303-20">}</span><spanclass="w">
</span><spanclass="s">"Expected a BCP47 language tag. Could not parse the remaining </span><spanclass="se">\"</span><spanclass="s">g</span><spanclass="se">\"</span><spanclass="s"> starting at position 11"</span><spanclass="p"data-group-id="7670766303-24">}</span><spanclass="p"data-group-id="7670766303-23">}</span></code></pre>
</span><spanclass="s">"No configured locale could be matched to </span><spanclass="se">\"</span><spanclass="s">xx,yy;q=0.3</span><spanclass="se">\"</span><spanclass="s">"</span><spanclass="p"data-group-id="3883030353-21">}</span><spanclass="p"data-group-id="3883030353-20">}</span><spanclass="w">
</span><spanclass="s">"Expected a BCP47 language tag. Could not parse the remaining </span><spanclass="se">\"</span><spanclass="s">g</span><spanclass="se">\"</span><spanclass="s"> starting at position 11"</span><spanclass="p"data-group-id="3883030353-24">}</span><spanclass="p"data-group-id="3883030353-23">}</span></code></pre>
</section>
</section>
<sectionclass="detail"id="parse/1">
@ -321,116 +319,116 @@ a configured <a href="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html"><code class="
<p>Parses an <codeclass="inline">Accept-Language</code> header value in its string
or tokenized form to return a tuple of the form
<codeclass="inline">{:ok, [{quality, %Cldr.LanguageTag{}}, ...]}</code> sorted by quality.</p><h2id="parse/1-arguments"class="section-heading">
<ul><li><p><codeclass="inline">accept-language</code> is any string in the format defined by
<ahref="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4">rfc2616</a></p></li><li><p><codeclass="inline">backend</code> is any module that includes <codeclass="inline">use Cldr</code> and therefore
is a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html"><codeclass="inline">Cldr</code></a> backend module</p></li></ul><h2id="parse/1-returns"class="section-heading">
<ul><li><p><codeclass="inline">{:ok, [{quality, language_tag}, ...]}</code> or</p></li><li><p><codeclass="inline">{:error, {Cldr.AcceptLanguageError, String.t}}</code></p></li></ul><p>If at least one valid language tag is found but errors are also
detected on one more more tags, an <codeclass="inline">{ok, list}</code> tuple is returned
wuth an error tuple for each invalid tag added at the end of the list.</p><h2id="parse/1-example"class="section-heading">
</span><spanclass="s">"Expected a BCP47 language tag. Could not parse the remaining </span><spanclass="se">\"</span><spanclass="s">g</span><spanclass="se">\"</span><spanclass="s"> starting at position 11"</span><spanclass="p"data-group-id="3154644560-22">}</span><spanclass="p"data-group-id="3154644560-21">}</span><spanclass="w">
</span><spanclass="s">"Expected a BCP47 language tag. Could not parse the remaining </span><spanclass="se">\"</span><spanclass="s">g</span><spanclass="se">\"</span><spanclass="s"> starting at position 11"</span><spanclass="p"data-group-id="6374671343-22">}</span><spanclass="p"data-group-id="6374671343-21">}</span><spanclass="w">
</span><spanclass="s">"Expected a BCP47 language tag. Could not parse the remaining </span><spanclass="se">\"</span><spanclass="s">g</span><spanclass="se">\"</span><spanclass="s"> starting at position 11"</span><spanclass="p"data-group-id="3154644560-43">}</span><spanclass="p"data-group-id="3154644560-42">}</span><spanclass="w">
</span><spanclass="s">"Expected a BCP47 language tag. Could not parse the remaining </span><spanclass="se">\"</span><spanclass="s">g</span><spanclass="se">\"</span><spanclass="s"> starting at position 11"</span><spanclass="p"data-group-id="6374671343-43">}</span><spanclass="p"data-group-id="6374671343-42">}</span><spanclass="w">
<ul><li><codeclass="inline">accept-language</code> is any string in the format defined by <ahref="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4">rfc2616</a></li></ul><h2id="parse!/1-returns"class="section-heading">
<ul><li><p><codeclass="inline">{:ok, [{quality, language_tag}, ...]}</code> or</p></li><li><p>raises a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.AcceptLanguageError.html"><codeclass="inline">Cldr.AcceptLanguageError</code></a> exception</p></li></ul><p>If at least one valid language tag is found but errors are also
detected on one more more tags, an <codeclass="inline">{ok, list}</code> tuple is returned
wuth an error tuple for each invalid tag added at the end of the list.</p><h2id="parse!/1-example"class="section-heading">
</span><spanclass="gt">** (Cldr.AcceptLanguageError) "Expected a BCP47 language tag. Could not parse the remaining "g" starting at position 11
</span><spanclass="s">"Expected a BCP47 language tag. Could not parse the remaining </span><spanclass="se">\"</span><spanclass="s">g</span><spanclass="se">\"</span><spanclass="s"> starting at position 11"</span><spanclass="p"data-group-id="2821277750-38">}</span><spanclass="p"data-group-id="2821277750-37">}</span><spanclass="w">
</span><spanclass="s">"Expected a BCP47 language tag. Could not parse the remaining </span><spanclass="se">\"</span><spanclass="s">g</span><spanclass="se">\"</span><spanclass="s"> starting at position 11"</span><spanclass="p"data-group-id="8507341301-38">}</span><spanclass="p"data-group-id="8507341301-37">}</span><spanclass="w">
<ul><li><p><codeclass="inline">locale</code> is any valid locale name returned by <codeclass="inline">MyApp.Cldr.known_locale_names/0</code>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <codeclass="inline">MyApp.Cldr.Locale.new!/1</code></p></li><li><p><codeclass="inline">currency_status</code> is <codeclass="inline">:all</code>, <codeclass="inline">:current</code>, <codeclass="inline">:historic</code>,
<codeclass="inline">unannotated</code> or <codeclass="inline">:tender</code>; or a list of one or more status.
The default is <codeclass="inline">:all</code>. See <ahref="https://hexdocs.pm/ex_cldr_currencies/2.15.0/Cldr.Currency.html#currency_filter/2"><codeclass="inline">Cldr.Currency.currency_filter/2</code></a>.</p></li></ul><h2id="currencies_for_locale/3-returns"class="section-heading">
<ul><li><p><codeclass="inline">locale</code> is any valid locale name returned by <codeclass="inline">MyApp.Cldr.known_locale_names/0</code>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <codeclass="inline">MyApp.Cldr.Locale.new!/1</code></p></li><li><p><codeclass="inline">currency_status</code> is <codeclass="inline">:all</code>, <codeclass="inline">:current</code>, <codeclass="inline">:historic</code>,
<codeclass="inline">unannotated</code> or <codeclass="inline">:tender</code>; or a list of one or more status.
The default is <codeclass="inline">:all</code>. See <ahref="https://hexdocs.pm/ex_cldr_currencies/2.15.0/Cldr.Currency.html#currency_filter/2"><codeclass="inline">Cldr.Currency.currency_filter/2</code></a>.</p></li></ul><h2id="currencies_for_locale!/3-returns"class="section-heading">
<ul><li><p><codeclass="inline">{:ok, currency_map}</code> or</p></li><li><p>raises an exception</p></li></ul><h2id="currencies_for_locale!/3-example"class="section-heading">
<ul><li><codeclass="inline">currency_or_currency_code</code> is a <codeclass="inline">binary</code> or <codeclass="inline">atom</code> representation
of an ISO 4217 currency code, or a <codeclass="inline">%Cldr.Currency{}</code> struct.</li></ul><h2id="currency_for_code/2-options"class="section-heading">
<ul><li><codeclass="inline">:locale</code> is any valid locale name returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new!/2"><codeclass="inline">Cldr.Locale.new!/2</code></a></li></ul><h2id="currency_for_code/2-returns"class="section-heading">
<ul><li><codeclass="inline">currency_or_currency_code</code> is a <codeclass="inline">binary</code> or <codeclass="inline">atom</code> representation
of an ISO 4217 currency code, or a <codeclass="inline">%Cldr.Currency{}</code> struct.</li></ul><h2id="currency_for_code!/2-options"class="section-heading">
<ul><li><codeclass="inline">:locale</code> is any valid locale name returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new!/2"><codeclass="inline">Cldr.Locale.new!/2</code></a></li></ul><h2id="currency_for_code!/2-returns"class="section-heading">
<ul><li><p>A <codeclass="inline">t:Cldr.Current.t/0</code> or</p></li><li><p>raises an exception</p></li></ul><h2id="currency_for_code!/2-examples"class="section-heading">
<ul><li><codeclass="inline">locale</code> is a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by
<ul><li><codeclass="inline">locale</code> is any valid locale name returned by <codeclass="inline">MyApp.Cldr.known_locale_names/0</code>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <codeclass="inline">MyApp.Cldr.Locale.new!/1</code></li></ul><h2id="currency_history_for_locale/1-example"class="section-heading">
<ul><li><p><codeclass="inline">locale</code> is any valid locale name returned by <codeclass="inline">MyApp.Cldr.known_locale_names/0</code>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <codeclass="inline">MyApp.Cldr.Locale.new!/1</code></p></li><li><p><codeclass="inline">currency_status</code> is <codeclass="inline">:all</code>, <codeclass="inline">:current</code>, <codeclass="inline">:historic</code>,
<codeclass="inline">unannotated</code> or <codeclass="inline">:tender</code>; or a list of one or more status.
The default is <codeclass="inline">:all</code>. See <ahref="https://hexdocs.pm/ex_cldr_currencies/2.15.0/Cldr.Currency.html#currency_filter/2"><codeclass="inline">Cldr.Currency.currency_filter/2</code></a>.</p></li></ul><h2id="currency_strings/3-returns"class="section-heading">
<ul><li><p><codeclass="inline">locale</code> is any valid locale name returned by <codeclass="inline">MyApp.Cldr.known_locale_names/0</code>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <codeclass="inline">MyApp.Cldr.Locale.new!/1</code></p></li><li><p><codeclass="inline">currency_status</code> is <codeclass="inline">:all</code>, <codeclass="inline">:current</code>, <codeclass="inline">:historic</code>,
<codeclass="inline">unannotated</code> or <codeclass="inline">:tender</code>; or a list of one or more status.
The default is <codeclass="inline">:all</code>. See <ahref="https://hexdocs.pm/ex_cldr_currencies/2.15.0/Cldr.Currency.html#currency_filter/2"><codeclass="inline">Cldr.Currency.currency_filter/2</code></a>.</p></li></ul><h2id="currency_strings!/3-returns"class="section-heading">
<ul><li><p><codeclass="inline">{:ok, currency_string_map}</code> or</p></li><li><p>raises an exception</p></li></ul><h2id="currency_strings!/3-example"class="section-heading">
@ -943,17 +941,17 @@ The default is <code class="inline">:all</code>. See <a href="https://hexdocs.pm
parameters <codeclass="inline">cu</code> or <codeclass="inline">rg</code>. It is recommended to us
<ahref="https://hexdocs.pm/ex_cldr_currencies/2.15.0/Cldr.Currency.html#currency_from_locale/1"><codeclass="inline">Cldr.Currency.currency_from_locale/1</code></a> in most
<ul><li><codeclass="inline">locale</code> is any valid locale name returned by <codeclass="inline">MyApp.Cldr.known_locale_names/0</code>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <codeclass="inline">MyApp.Cldr.Locale.new!/1</code></li></ul><h2id="current_currency_from_locale/1-example"class="section-heading">
</span><spanclass="p"data-group-id="5100231780-2">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="5100231780-3">{</span><spanclass="nc">Cldr.UnknownCurrencyError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The currency </span><spanclass="se">\"</span><spanclass="s">GGG</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="5100231780-3">}</span><spanclass="p"data-group-id="5100231780-2">}</span></code></pre>
</span><spanclass="p"data-group-id="2920866228-2">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="2920866228-3">{</span><spanclass="nc">Cldr.UnknownCurrencyError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The currency </span><spanclass="se">\"</span><spanclass="s">GGG</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="2920866228-3">}</span><spanclass="p"data-group-id="2920866228-2">}</span></code></pre>
which is <codeclass="inline">X</code> followed by two alphanumeric characters.</p></li><li><p><codeclass="inline">options</code> is a map of options representing the optional elements of
the <codeclass="inline">Cldr.Currency.t</code> struct.</p></li></ul><h2id="new/2-options"class="section-heading">
<ul><li><codeclass="inline">:name</code> is the name of the currency. Required.</li><li><codeclass="inline">:digits</code> is the precision of the currency. Required.</li><li><codeclass="inline">:symbol</code> is the currency symbol. Optional.</li><li><codeclass="inline">:narrow_symbol</code> is an alternative narrow symbol. Optional.</li><li><codeclass="inline">:round_nearest</code> is the rounding precision such as <codeclass="inline">0.05</code>. Optional.</li><li><codeclass="inline">:alt_code</code> is an alternative currency code for application use.</li><li><codeclass="inline">:cash_digits</code> is the precision of the currency when used as cash. Optional.</li><li><codeclass="inline">:cash_rounding_nearest</code> is the rounding precision when used as cash
such as <codeclass="inline">0.05</code>. Optional.</li></ul><h2id="new/2-returns"class="section-heading">
</span><spanclass="p"data-group-id="5815839872-6">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"Required options are missing. Required options are [:name, :digits]"</span><spanclass="p"data-group-id="5815839872-6">}</span><spanclass="w">
</span><spanclass="p"data-group-id="5815839872-8">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="5815839872-9">{</span><spanclass="nc">Cldr.CurrencyAlreadyDefined</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"Currency :XAE is already defined."</span><spanclass="p"data-group-id="5815839872-9">}</span><spanclass="p"data-group-id="5815839872-8">}</span></code></pre>
</span><spanclass="p"data-group-id="5426548412-6">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"Required options are missing. Required options are [:name, :digits]"</span><spanclass="p"data-group-id="5426548412-6">}</span><spanclass="w">
</span><spanclass="p"data-group-id="5426548412-8">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="5426548412-9">{</span><spanclass="nc">Cldr.CurrencyAlreadyDefined</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"Currency :XAE is already defined."</span><spanclass="p"data-group-id="5426548412-9">}</span><spanclass="p"data-group-id="5426548412-8">}</span></code></pre>
</section>
</section>
<sectionclass="detail"id="pluralize/3">
@ -1303,45 +1301,45 @@ such as <code class="inline">0.05</code>. Optional.</li></ul><h2 id="new/2-retur
<p>Returns the appropriate currency display name for the <codeclass="inline">currency</code>, based
on the plural rules in effect for the <codeclass="inline">locale</code>.</p><h2id="pluralize/3-arguments"class="section-heading">
<ul><li><p><codeclass="inline">number</code> is an integer, float or <ahref="https://hexdocs.pm/decimal/2.1.1/Decimal.html"><codeclass="inline">Decimal</code></a></p></li><li><p><codeclass="inline">currency</code> is any currency returned by <ahref="https://hexdocs.pm/ex_cldr_currencies/2.15.0/Cldr.Currency.html#known_currencies/0"><codeclass="inline">Cldr.Currency.known_currencies/0</code></a></p></li><li><p><codeclass="inline">options</code> is a keyword list of options</p></li></ul><h2id="pluralize/3-options"class="section-heading">
<ul><li><codeclass="inline">locale</code> is any valid locale name returned by <codeclass="inline">MyApp.Cldr.known_locale_names/0</code>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <codeclass="inline">MyApp.Cldr.Locale.new!/1</code>. The
default is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a></li></ul><h2id="pluralize/3-returns"class="section-heading">
</span><spanclass="p"data-group-id="2887946603-4">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"dollars des États-Unis"</span><spanclass="p"data-group-id="2887946603-4">}</span><spanclass="w">
</span><spanclass="p"data-group-id="6255705710-4">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"dollars des États-Unis"</span><spanclass="p"data-group-id="6255705710-4">}</span><spanclass="w">
</span><spanclass="p"data-group-id="2887946603-5">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"dollar des États-Unis"</span><spanclass="p"data-group-id="2887946603-5">}</span></code></pre>
</span><spanclass="p"data-group-id="6255705710-5">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"dollar des États-Unis"</span><spanclass="p"data-group-id="6255705710-5">}</span></code></pre>
<ul><li><p><codeclass="inline">currency</code> is an ISO4217 currency code</p></li><li><p><codeclass="inline">locale</code> is any valid locale name returned by <codeclass="inline">MyApp.Cldr.known_locale_names/0</code>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <codeclass="inline">MyApp.Cldr.Locale.new!/1</code></p></li></ul><h2id="strings_for_currency/2-returns"class="section-heading">
<ul><li><p>A list of strings or</p></li><li><p><codeclass="inline">{:error, {exception, reason}}</code></p></li></ul><h2id="strings_for_currency/2-example"class="section-heading">
<ul><li><codeclass="inline">territory</code> is any ISO 3166 Alpha-2 territory
code that can be validated by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#validate_territory/1"><codeclass="inline">Cldr.validate_territory/1</code></a></li></ul><h2id="locale_for_territory/1-returns"class="section-heading">
<ul><li><p><codeclass="inline">host</code> is any valid host name</p></li><li><p><codeclass="inline">options</code> is a keyword list of options. The default
is <codeclass="inline">[]</code>.</p></li></ul><h2id="locale_from_host/2-options"class="section-heading">
<ul><li><codeclass="inline">:tlds</code> is a list of territory codes as upper-cased
atoms that are to be considered as top-level domains.
See <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#locale_from_host/2"><codeclass="inline">Cldr.Locale.locale_from_host/2</code></a> for the default
</span><spanclass="p"data-group-id="7508794902-4">{</span><spanclass="nc">Cldr.UnknownLocaleError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"No locale was identified for territory </span><spanclass="se">\"</span><spanclass="s">tv</span><spanclass="se">\"</span><spanclass="s">"</span><spanclass="p"data-group-id="7508794902-4">}</span><spanclass="p"data-group-id="7508794902-3">}</span><spanclass="w">
</span><spanclass="p"data-group-id="3018953917-4">{</span><spanclass="nc">Cldr.UnknownLocaleError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"No locale was identified for territory </span><spanclass="se">\"</span><spanclass="s">tv</span><spanclass="se">\"</span><spanclass="s">"</span><spanclass="p"data-group-id="3018953917-4">}</span><spanclass="p"data-group-id="3018953917-3">}</span><spanclass="w">
</span><spanclass="p"data-group-id="7508794902-7">{</span><spanclass="nc">Cldr.UnknownLocaleError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"No locale was identified for territory </span><spanclass="se">\"</span><spanclass="s">com</span><spanclass="se">\"</span><spanclass="s">"</span><spanclass="p"data-group-id="7508794902-7">}</span><spanclass="p"data-group-id="7508794902-6">}</span></code></pre>
</span><spanclass="p"data-group-id="3018953917-7">{</span><spanclass="nc">Cldr.UnknownLocaleError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"No locale was identified for territory </span><spanclass="se">\"</span><spanclass="s">com</span><spanclass="se">\"</span><spanclass="s">"</span><spanclass="p"data-group-id="3018953917-7">}</span><spanclass="p"data-group-id="3018953917-6">}</span></code></pre>
<ul><li><codeclass="inline">language_tag</code> is any language tag returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new/2"><codeclass="inline">Cldr.Locale.new/2</code></a>
or any <codeclass="inline">locale_name</code> returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>.</li></ul><h2id="script_direction_from_locale/1-returns"class="section-heading">
</span><spanclass="p"data-group-id="6602177919-5">{</span><spanclass="nc">Cldr.UnknownLocaleError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"No locale was identified for territory </span><spanclass="se">\"</span><spanclass="s">com</span><spanclass="se">\"</span><spanclass="s">"</span><spanclass="p"data-group-id="6602177919-5">}</span><spanclass="p"data-group-id="6602177919-4">}</span></code></pre>
</span><spanclass="p"data-group-id="4509646857-5">{</span><spanclass="nc">Cldr.UnknownLocaleError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"No locale was identified for territory </span><spanclass="se">\"</span><spanclass="s">com</span><spanclass="se">\"</span><spanclass="s">"</span><spanclass="p"data-group-id="4509646857-5">}</span><spanclass="p"data-group-id="4509646857-4">}</span></code></pre>
<ul><li><p>A time zone ID as a string or</p></li><li><p><codeclass="inline">:error</code> if no time zone can be determined</p></li></ul><h2id="timezone_from_locale/1-examples"class="section-heading">
<ul><li><p><codeclass="inline">number</code> is any <codeclass="inline">integer</code>, <codeclass="inline">float</code> or <ahref="https://hexdocs.pm/decimal/2.1.1/Decimal.html"><codeclass="inline">Decimal</code></a></p></li><li><p><codeclass="inline">locale</code> is any locale returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new!/2"><codeclass="inline">Cldr.Locale.new!/2</code></a> or any
<codeclass="inline">locale_name</code> returned by <ahref="Plausible.Cldr.html#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a></p></li><li><p><codeclass="inline">rounding</code> is one of <codeclass="inline">[:down, :up, :ceiling, :floor, :half_even, :half_up, :half_down]</code>. The
default is <codeclass="inline">:half_even</code>.</p></li></ul><h2id="plural_rule/3-examples"class="section-heading">
<ul><li><codeclass="inline">locale</code> is any locale returned by <ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a> or any
<codeclass="inline">locale_name</code> returned by <ahref="Plausible.Cldr.html#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a></li></ul><p>The rules are returned in AST form after parsing.</p>
@ -414,45 +412,45 @@ default is <code class="inline">:half_even</code>.</p></li></ul><h2 id="plural_r
<p>Pluralize a number using cardinal plural rules
and a substitution map.</p><h2id="pluralize/3-arguments"class="section-heading">
<ul><li><p><codeclass="inline">number</code> is an integer, float or Decimal</p></li><li><p><codeclass="inline">locale</code> is any locale returned by <ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a> or any
<codeclass="inline">locale_name</code> returned by <ahref="Plausible.Cldr.html#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a></p></li><li><p><codeclass="inline">substitutions</code> is a map that maps plural keys to a string.
The valid substitution keys are <codeclass="inline">:zero</code>, <codeclass="inline">:one</code>, <codeclass="inline">:two</code>,
<codeclass="inline">:few</code>, <codeclass="inline">:many</code> and <codeclass="inline">:other</code>.</p></li></ul><p>See also <codeclass="inline">Plausible.Cldr.Number.Cardinal.Cardinal.plural_rule/3</code>.</p><h2id="pluralize/3-examples"class="section-heading">
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by
<ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a>. The default
is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</li></ul><h2id="all_formats_for/1-returns"class="section-heading">
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by
<ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a>. The default
is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</li></ul><h2id="all_formats_for!/1-returns"class="section-heading">
<ul><li><p><codeclass="inline">{:ok, map}</code> where map is a map of decimal formats
keyed by number system or</p></li><li><p>raises an exception</p></li></ul><p>See <codeclass="inline">Plausible.Cldr.Number.Format.Number.Format.all_formats_for/1</code> for further information.</p>
@ -435,13 +433,13 @@ number system.</p>
<p>Returns the list of decimal formats in the configured locales including
the list of locales configured for precompilation in <codeclass="inline">config.exs</code>.</p><p>This function exists to allow the decimal formatter
to precompile all the known formats at compile time.</p><h2id="decimal_format_list/0-example"class="section-heading">
@ -494,13 +492,13 @@ or a <a href="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><code cla
<ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a>. The default
is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</li></ul><p>This function exists to allow the decimal formatter to precompile all
the known formats at compile time. Its use is not otherwise recommended.</p><h2id="decimal_format_list_for/1-example"class="section-heading">
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by
<ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a>. The default
is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</li></ul><h2id="default_grouping_for/1-returns"class="section-heading">
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by
<ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a>. The default
is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</li></ul><h2id="default_grouping_for!/1-returns"class="section-heading">
<ul><li><p><codeclass="inline">grouping</code> as a map or</p></li><li><p>raises an exception</p></li></ul><h2id="default_grouping_for!/1-examples"class="section-heading">
@ -649,10 +647,10 @@ is <a href="Plausible.Cldr.html#get_locale/0"><code class="inline">Plausible.Cld
</div>
<p>Return the predfined formats for a given <codeclass="inline">locale</code> and <codeclass="inline">number_system</code>.</p><h2id="formats_for/2-arguments"class="section-heading">
@ -660,10 +658,10 @@ or a <a href="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><code cla
<ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a>. The default
is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</p></li><li><p><codeclass="inline">number_system</code> is any valid number system or number system type returned
by <ahref="Plausible.Cldr.Number.System.html#number_systems_for/1"><codeclass="inline">Plausible.Cldr.Number.System.number_systems_for/1</code></a>.</p></li></ul><h2id="formats_for/2-example"class="section-heading">
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by
<ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a>. The default
is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</li></ul><h2id="minimum_grouping_digits_for/1-returns"class="section-heading">
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by
<ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a>. The default
is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</li></ul><h2id="minimum_grouping_digits_for!/1-returns"class="section-heading">
<ul><li><p><codeclass="inline">minumum_digits</code> or</p></li><li><p>raises an exception</p></li></ul><h2id="minimum_grouping_digits_for!/1-examples"class="section-heading">
<ul><li><p><codeclass="inline">number</code> is an integer, float or Decimal</p></li><li><p><codeclass="inline">format</code> is a format string. See <ahref="Plausible.Cldr.Number.html"><codeclass="inline">Plausible.Cldr.Number</code></a> for further information.</p></li><li><p><codeclass="inline">options</code> is a map of options. See <ahref="Plausible.Cldr.Number.html#to_string/2"><codeclass="inline">Plausible.Cldr.Number.to_string/2</code></a>
for further information.</p></li></ul>
@ -243,7 +241,7 @@ for further information.</p></li></ul>
<pclass="built-using">
Built using
<ahref="https://github.com/elixir-lang/ex_doc"title="ExDoc"target="_blank"rel="help noopener"translate="no">ExDoc</a> (v0.29.4) for the
<ahref="https://github.com/elixir-lang/ex_doc"title="ExDoc"target="_blank"rel="help noopener"translate="no">ExDoc</a> (v0.30.3) for the
<ul><li><p><codeclass="inline">number</code> is any <codeclass="inline">integer</code>, <codeclass="inline">float</code> or <ahref="https://hexdocs.pm/decimal/2.1.1/Decimal.html"><codeclass="inline">Decimal</code></a></p></li><li><p><codeclass="inline">locale</code> is any locale returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new!/2"><codeclass="inline">Cldr.Locale.new!/2</code></a> or any
<codeclass="inline">locale_name</code> returned by <ahref="Plausible.Cldr.html#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a></p></li><li><p><codeclass="inline">rounding</code> is one of <codeclass="inline">[:down, :up, :ceiling, :floor, :half_even, :half_up, :half_down]</code>. The
default is <codeclass="inline">:half_even</code>.</p></li></ul><h2id="plural_rule/3-examples"class="section-heading">
<ul><li><codeclass="inline">locale</code> is any locale returned by <ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a> or any
<codeclass="inline">locale_name</code> returned by <ahref="Plausible.Cldr.html#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a></li></ul><p>The rules are returned in AST form after parsing.</p>
@ -414,10 +412,10 @@ default is <code class="inline">:half_even</code>.</p></li></ul><h2 id="plural_r
<p>Pluralize a number using ordinal plural rules
and a substitution map.</p><h2id="pluralize/3-arguments"class="section-heading">
<ul><li><p><codeclass="inline">number</code> is an integer, float or Decimal or a <codeclass="inline">Range.t{}</code>. When a range, The
is that in any usage, the start value is strictly less than the end value,
@ -426,36 +424,36 @@ these criteria are undefined.</p></li><li><p><code class="inline">locale</code>
<codeclass="inline">locale_name</code> returned by <ahref="Plausible.Cldr.html#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a></p></li><li><p><codeclass="inline">substitutions</code> is a map that maps plural keys to a string.
The valid substitution keys are <codeclass="inline">:zero</code>, <codeclass="inline">:one</code>, <codeclass="inline">:two</code>,
<codeclass="inline">:few</code>, <codeclass="inline">:many</code> and <codeclass="inline">:other</code>.</p></li></ul><p>See also <codeclass="inline">Plausible.Cldr.Number.Ordinal.Ordinal.plural_rule/3</code>.</p><h2id="pluralize/3-examples"class="section-heading">
<ul><li><p><codeclass="inline">first</code> is a plural type for the start of a range</p></li><li><p><codeclass="inline">last</code> is a plural type for the end of a range</p></li><li><p><codeclass="inline">locale</code> is any <codeclass="inline">Cldr.LanguageTag.t</code> or a language name
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by
<ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a>. The default
is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</li></ul><h2id="number_symbols_for/1-example"class="section-heading">
@ -244,9 +243,8 @@ string or raises on error.</p></div>
<h1class="section-heading">
<aclass="hover-link"href="#functions">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
</a>
Functions
</a>
</h1>
<divclass="functions-list">
<sectionclass="detail"id="number_system_for/2">
@ -284,29 +282,29 @@ or a <a href="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><code cla
returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_number_system_types/0"><codeclass="inline">Cldr.known_number_system_types/0</code></a></p></li></ul><p>This function will decode a number system type into the actual
number system. If the number system provided can't be decoded
it is returned as is.</p><h2id="number_system_for/2-examples"class="section-heading">
</span><spanclass="s">"The number system :finance is unknown for the locale named :en. Valid number systems are %{default: :latn, native: :latn}"</span><spanclass="p"data-group-id="6807308997-10">}</span><spanclass="w">
</span><spanclass="s">"The number system :finance is unknown for the locale named :en. Valid number systems are %{default: :latn, native: :latn}"</span><spanclass="p"data-group-id="1055488273-10">}</span><spanclass="w">
<ul><li><codeclass="inline">locale</code> is any language tag returned be <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new/2"><codeclass="inline">Cldr.Locale.new/2</code></a>
or a locale name in the list returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a></li></ul><h2id="number_system_from_locale/1-returns"class="section-heading">
@ -391,16 +389,16 @@ or a locale name in the list returned by <a href="https://hexdocs.pm/ex_cldr/2.3
<p>Returns the number systems available for a locale
or <codeclass="inline">{:error, message}</code> if the locale is not known.</p><ul><li><codeclass="inline">locale</code> is any valid locale name returned by <ahref="Plausible.Cldr.html#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a></li></ul><h2id="number_system_names_for/1-examples"class="section-heading">
</span><spanclass="p"data-group-id="8910661823-3">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="8910661823-4">{</span><spanclass="nc">Cldr.InvalidLanguageError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The language </span><spanclass="se">\"</span><spanclass="s">zz</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="8910661823-4">}</span><spanclass="p"data-group-id="8910661823-3">}</span></code></pre>
</span><spanclass="p"data-group-id="1881247936-3">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="1881247936-4">{</span><spanclass="nc">Cldr.InvalidLanguageError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The language </span><spanclass="se">\"</span><spanclass="s">zz</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="1881247936-4">}</span><spanclass="p"data-group-id="1881247936-3">}</span></code></pre>
@ -476,19 +474,19 @@ or a <a href="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><code cla
<p>Returns the number systems available for a locale
or <codeclass="inline">{:error, message}</code> if the locale is not known.</p><ul><li><codeclass="inline">locale</code> is any valid locale name returned by <ahref="Plausible.Cldr.html#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a></li></ul><h2id="number_systems_for/1-examples"class="section-heading">
</span><spanclass="p"data-group-id="5680555986-5">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="5680555986-6">{</span><spanclass="nc">Cldr.InvalidLanguageError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The language </span><spanclass="se">\"</span><spanclass="s">zz</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="5680555986-6">}</span><spanclass="p"data-group-id="5680555986-5">}</span></code></pre>
</span><spanclass="p"data-group-id="4207333923-5">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="4207333923-6">{</span><spanclass="nc">Cldr.InvalidLanguageError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The language </span><spanclass="se">\"</span><spanclass="s">zz</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="4207333923-6">}</span><spanclass="p"data-group-id="4207333923-5">}</span></code></pre>
</section>
</section>
<sectionclass="detail"id="number_systems_for!/1">
@ -581,25 +579,25 @@ or a <a href="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><code cla
consistent fashion for a given use</p></li><li><p>WIth the number system name directly, such as :latn, :arab or any of the
other 70 or so</p></li></ul><p>This function dereferences the supplied <codeclass="inline">system_name</code> and returns the
actual system name.</p><h2id="system_name_from/2-examples"class="section-heading">
</span><spanclass="p"data-group-id="8705856008-9">{</span><spanclass="nc">Cldr.UnknownNumberSystemError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The number system :nope is unknown"</span><spanclass="p"data-group-id="8705856008-9">}</span><spanclass="w">
</span><spanclass="p"data-group-id="8705856008-8">}</span></code></pre><p>Note that return value is not guaranteed to be a valid
</span><spanclass="p"data-group-id="2529885955-9">{</span><spanclass="nc">Cldr.UnknownNumberSystemError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The number system :nope is unknown"</span><spanclass="p"data-group-id="2529885955-9">}</span><spanclass="w">
</span><spanclass="p"data-group-id="2529885955-8">}</span></code></pre><p>Note that return value is not guaranteed to be a valid
number system for the given locale as demonstrated in the third example.</p>
</section>
</section>
@ -640,22 +638,22 @@ These rulesets are considered by CLDR to be
less rigorous than the <codeclass="inline">:numeric</code> number systems
and caution and testing for a specific use case
is recommended.</p></li></ul><h2id="to_system/2-examples"class="section-heading">
@ -683,10 +681,10 @@ string or raises on error.</p><ul><li><p><code class="inline">number</code> is a
<ahref="Plausible.Cldr.html#known_number_systems/0"><codeclass="inline">Plausible.Cldr.known_number_systems/0</code></a> or a number system type
returned by <ahref="Plausible.Cldr.html#known_number_system_types/0"><codeclass="inline">Plausible.Cldr.known_number_system_types/0</code></a></p></li></ul><p>See <ahref="#to_system/2"><codeclass="inline">Plausible.Cldr.Number.System.to_system/2</code></a> for further
Configuring precompilation of digit transliterations
</a>
Configuring precompilation of digit transliterations
</h3>
<p>This module includes <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.Transliterate.html#transliterate_digits/3"><codeclass="inline">Cldr.Number.Transliterate.transliterate_digits/3</code></a> which transliterates
digits between number systems. For example from :arabic to :latn. Since generating a
transliteration map is slow, pairs of transliterations can be configured so that the
transliteration map is created at compile time and therefore speeding up transliteration at
run time.</p><p>To configure these transliteration pairs, add the to the <codeclass="inline">use Cldr</code> configuration
in a backend module:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="kd">defmodule</span><spanclass="w"></span><spanclass="nc">MyApp.Cldr</span><spanclass="w"></span><spanclass="k"data-group-id="8157956167-1">do</span><spanclass="w">
in a backend module:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="kd">defmodule</span><spanclass="w"></span><spanclass="nc">MyApp.Cldr</span><spanclass="w"></span><spanclass="k"data-group-id="6311164137-1">do</span><spanclass="w">
</span><spanclass="k"data-group-id="8157956167-1">end</span></code></pre><p>Where each tuple in the list configures one transliteration map. In this example, two maps are
</span><spanclass="k"data-group-id="6311164137-1">end</span></code></pre><p>Where each tuple in the list configures one transliteration map. In this example, two maps are
configured: from <codeclass="inline">:latn</code> to <codeclass="inline">:thai</code> and from <codeclass="inline">:arab</code> to <codeclass="inline">:thai</code>.</p><p>A list of configurable number systems is returned by <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.System.html#systems_with_digits/0"><codeclass="inline">Cldr.Number.System.systems_with_digits/0</code></a>.</p><p>If a transliteration is requested between two number pairs that have not been configured for
precompilation, a warning is logged.</p>
</section>
@ -148,9 +148,8 @@ precompilation, a warning is logged.</p>
<h1class="section-heading">
<aclass="hover-link"href="#summary">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
Summary
</a>
Summary
</h1>
<divclass="summary-functions summary">
<h2>
@ -194,9 +193,8 @@ precompilation, a warning is logged.</p>
<h1class="section-heading">
<aclass="hover-link"href="#functions">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
</a>
Functions
</a>
</h1>
<divclass="functions-list">
<sectionclass="detail"id="transliterate/3">
@ -236,10 +234,10 @@ Functions
another number system. Also transliterates the decimal and grouping
separators as well as the plus, minus and exponent symbols. Any other character
in the string will be returned "as is".</p><h2id="transliterate/3-arguments"class="section-heading">
<ul><li><p><codeclass="inline">sequence</code> is the string to be transliterated.</p></li><li><p><codeclass="inline">locale</code> is any known locale, defaulting to <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</p></li><li><p><codeclass="inline">number_system</code> is any known number system. If expressed as a <codeclass="inline">string</code> it
is the actual name of a known number system. If epressed as an <codeclass="inline">atom</code> it is
@ -249,27 +247,27 @@ standard). See <a href="Plausible.Cldr.Number.System.html#number_systems_for/1">
see what number system types are defined. The default is <codeclass="inline">:default</code>.</p></li></ul><p>For available number systems see <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.System.html#number_systems/0"><codeclass="inline">Cldr.Number.System.number_systems/0</code></a>
and <ahref="Plausible.Cldr.Number.System.html#number_systems_for/1"><codeclass="inline">Plausible.Cldr.Number.System.number_systems_for/1</code></a>. Also see
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number.Transliterate</span><spanclass="o">.</span><spanclass="n">transliterate</span><spanclass="p"data-group-id="0638645401-6">(</span><spanclass="s">"Some number is: 123556"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"th"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"thai"</span><spanclass="p"data-group-id="0638645401-6">)</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number.Transliterate</span><spanclass="o">.</span><spanclass="n">transliterate</span><spanclass="p"data-group-id="5206531574-6">(</span><spanclass="s">"Some number is: 123556"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"th"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"thai"</span><spanclass="p"data-group-id="5206531574-6">)</span><spanclass="w">
</span><spanclass="s">"Some number is: ๑๒๓๕๕๖"</span></code></pre>
</section>
</section>
@ -326,10 +324,10 @@ and <a href="Plausible.Cldr.Number.System.html#number_systems_for/1"><code class
<p>Transliterates digits from one number system to another number system</p><ul><li><p><codeclass="inline">digits</code> is binary representation of a number</p></li><li><p><codeclass="inline">from_system</code> and <codeclass="inline">to_system</code> are number system names in atom form. See
<ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.System.html#systems_with_digits/0"><codeclass="inline">Cldr.Number.System.systems_with_digits/0</code></a> for available number systems.</p></li></ul><h2id="transliterate_digits/3-example"class="section-heading">
@ -119,10 +119,10 @@ There are several classes of formatting including non-scientific, scientific,
rules based (for spelling and ordinal formats), compact formats that display <codeclass="inline">1k</code>
rather than <codeclass="inline">1,000</code> and so on. See <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.html#to_string/2"><codeclass="inline">Cldr.Number.to_string/2</code></a> for specific formatting
<ul><li><p><codeclass="inline">string</code> is any <codeclass="inline">String.t</code></p></li><li><p><codeclass="inline">options</code> is a keyword list of options</p></li></ul><h2id="parse/2-options"class="section-heading">
<ul><li><p>A number of the requested or default type or</p></li><li><p><codeclass="inline">{:error, {exception, error}}</code> if no number could be determined</p></li></ul><h2id="parse/2-notes"class="section-heading">
</span><spanclass="s">"The string </span><spanclass="se">\"</span><spanclass="s">+1.000,34</span><spanclass="se">\"</span><spanclass="s"> could not be parsed as a number"</span><spanclass="p"data-group-id="3049631823-9">}</span><spanclass="p"data-group-id="3049631823-8">}</span></code></pre>
</span><spanclass="s">"The string </span><spanclass="se">\"</span><spanclass="s">+1.000,34</span><spanclass="se">\"</span><spanclass="s"> could not be parsed as a number"</span><spanclass="p"data-group-id="0097258204-9">}</span><spanclass="p"data-group-id="0097258204-8">}</span></code></pre>
</section>
</section>
<sectionclass="detail"id="resolve_currencies/2">
@ -452,17 +450,17 @@ using the Elixir standard library functions.</p><h2 id="parse/2-examples" class=
<p>Resolve curencies from strings within
a list.</p><h2id="resolve_currencies/2-arguments"class="section-heading">
<ul><li><p><codeclass="inline">list</code> is any list in which currency
names and symbols are expected</p></li><li><p><codeclass="inline">options</code> is a keyword list of options</p></li></ul><h2id="resolve_currencies/2-options"class="section-heading">
<ul><li><p><codeclass="inline">:locale</code> is any valid locale returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new!/2"><codeclass="inline">Cldr.Locale.new!/2</code></a>
@ -479,10 +477,10 @@ currency string is <em>close enough</em> to a known currency
string for it to identify definitively a currency code.
It is recommended to use numbers greater than <codeclass="inline">0.8</code> in
order to reduce false positives.</p></li></ul><h2id="resolve_currencies/2-notes"class="section-heading">
<p>The <codeclass="inline">:only</code> and <codeclass="inline">:except</code> options accept a list of
currency codes and/or currency types. The following
@ -493,22 +491,22 @@ entries.</p><ul><li><p><code class="inline">:all</code>, the default, considers
date of nil and which also is a known ISO4217 currency</p></li><li><p><codeclass="inline">:historic</code> is the opposite of <codeclass="inline">:current</code></p></li><li><p><codeclass="inline">:tender</code> considers currencies that are legal tender</p></li><li><p><codeclass="inline">:unannotated</code> considers currencies that don't have
"(some string)" in their names. These are usually
<pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">scan</span><spanclass="p"data-group-id="1157423681-1">(</span><spanclass="s">"100 US dollars"</span><spanclass="p"data-group-id="1157423681-1">)</span><spanclass="w">
<pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">scan</span><spanclass="p"data-group-id="1488471506-1">(</span><spanclass="s">"100 US dollars"</span><spanclass="p"data-group-id="1488471506-1">)</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">scan</span><spanclass="p"data-group-id="1157423681-6">(</span><spanclass="s">"100 dollars des États-Unis"</span><spanclass="p"data-group-id="1157423681-6">)</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">scan</span><spanclass="p"data-group-id="1488471506-6">(</span><spanclass="s">"100 dollars des États-Unis"</span><spanclass="p"data-group-id="1488471506-6">)</span><spanclass="w">
<ul><li><p><codeclass="inline">list</code> is any list in which currency
names and symbols are expected</p></li><li><p><codeclass="inline">options</code> is a keyword list of options</p></li></ul><h2id="resolve_currency/2-options"class="section-heading">
<ul><li><p><codeclass="inline">:locale</code> is any valid locale returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new!/2"><codeclass="inline">Cldr.Locale.new!/2</code></a>
@ -560,16 +558,16 @@ currency string is <em>close enough</em> to a known currency
string for it to identify definitively a currency code.
It is recommended to use numbers greater than <codeclass="inline">0.8</code> in
order to reduce false positives.</p></li></ul><h2id="resolve_currency/2-returns"class="section-heading">
<ul><li><p>An ISO4217 currency code as an atom or</p></li><li><p><codeclass="inline">{:error, {exception, message}}</code></p></li></ul><h2id="resolve_currency/2-notes"class="section-heading">
<p>The <codeclass="inline">:only</code> and <codeclass="inline">:except</code> options accept a list of
currency codes and/or currency types. The following
@ -580,24 +578,24 @@ entries.</p><ul><li><p><code class="inline">:all</code>, the default, considers
date of nil and which also is a known ISO4217 currency</p></li><li><p><codeclass="inline">:historic</code> is the opposite of <codeclass="inline">:current</code></p></li><li><p><codeclass="inline">:tender</code> considers currencies that are legal tender</p></li><li><p><codeclass="inline">:unannotated</code> considers currencies that don't have
"(some string)" in their names. These are usually
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">resolve_currency</span><spanclass="p"data-group-id="5148718684-5">(</span><spanclass="s">"dollars des États-Unis"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">locale</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"fr"</span><spanclass="p"data-group-id="5148718684-5">)</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">resolve_currency</span><spanclass="p"data-group-id="0065334569-5">(</span><spanclass="s">"dollars des États-Unis"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">locale</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"fr"</span><spanclass="p"data-group-id="0065334569-5">)</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">resolve_currency</span><spanclass="p"data-group-id="5148718684-7">(</span><spanclass="s">"not a known currency"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">locale</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"fr"</span><spanclass="p"data-group-id="5148718684-7">)</span><spanclass="w">
</span><spanclass="s">"The currency </span><spanclass="se">\"</span><spanclass="s">not a known currency</span><spanclass="se">\"</span><spanclass="s"> is unknown or not supported"</span><spanclass="p"data-group-id="5148718684-9">}</span><spanclass="p"data-group-id="5148718684-8">}</span></code></pre>
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">resolve_currency</span><spanclass="p"data-group-id="0065334569-7">(</span><spanclass="s">"not a known currency"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">locale</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"fr"</span><spanclass="p"data-group-id="0065334569-7">)</span><spanclass="w">
</span><spanclass="s">"The currency </span><spanclass="se">\"</span><spanclass="s">not a known currency</span><spanclass="se">\"</span><spanclass="s"> is unknown or not supported"</span><spanclass="p"data-group-id="0065334569-9">}</span><spanclass="p"data-group-id="0065334569-8">}</span></code></pre>
<ul><li><p><codeclass="inline">list</code> is any list in which percent
and permille symbols are expected</p></li><li><p><codeclass="inline">options</code> is a keyword list of options</p></li></ul><h2id="resolve_per/2-options"class="section-heading">
<ul><li><codeclass="inline">:locale</code> is any valid locale returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new!/2"><codeclass="inline">Cldr.Locale.new!/2</code></a>
The default is <codeclass="inline">options[:backend].get_locale()</code></li></ul><h2id="resolve_per/2-returns"class="section-heading">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">resolve_per</span><spanclass="w"></span><spanclass="s">"% of linguists"</span><spanclass="w">
</span><spanclass="p"data-group-id="4938239620-2">[</span><spanclass="ss">:percent</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">" of linguists"</span><spanclass="p"data-group-id="4938239620-2">]</span><spanclass="w">
</span><spanclass="p"data-group-id="7631570236-2">[</span><spanclass="ss">:percent</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">" of linguists"</span><spanclass="p"data-group-id="7631570236-2">]</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">resolve_per</span><spanclass="w"></span><spanclass="s">"% of linguists %"</span><spanclass="w">
</span><spanclass="p"data-group-id="4938239620-3">[</span><spanclass="ss">:percent</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">" of linguists "</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">:percent</span><spanclass="p"data-group-id="4938239620-3">]</span></code></pre>
</span><spanclass="p"data-group-id="7631570236-3">[</span><spanclass="ss">:percent</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">" of linguists "</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">:percent</span><spanclass="p"data-group-id="7631570236-3">]</span></code></pre>
</section>
</section>
<sectionclass="detail"id="resolve_pers/2">
@ -704,29 +702,29 @@ The default is <code class="inline">options[:backend].get_locale()</code></li></
<p>Resolve and tokenize percent and permille
sybols from strings within a list.</p><p>Percent and permille symbols can be identified
at the beginning and/or the end of a string.</p><h2id="resolve_pers/2-arguments"class="section-heading">
<ul><li><p><codeclass="inline">list</code> is any list in which percent and
permille symbols are expected</p></li><li><p><codeclass="inline">options</code> is a keyword list of options</p></li></ul><h2id="resolve_pers/2-options"class="section-heading">
<ul><li><codeclass="inline">:locale</code> is any valid locale returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>
or a <codeclass="inline">t:Cldr.LanguageTag</code> struct returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new!/2"><codeclass="inline">Cldr.Locale.new!/2</code></a>
The default is <codeclass="inline">options[:backend].get_locale()</code></li></ul><h2id="resolve_pers/2-examples"class="section-heading">
<ul><li><p><codeclass="inline">string</code> is any <codeclass="inline">String.t</code></p></li><li><p><codeclass="inline">options</code> is a keyword list of options</p></li></ul><h2id="scan/2-options"class="section-heading">
<ul><li><p><codeclass="inline">:number</code> is one of <codeclass="inline">:integer</code>, <codeclass="inline">:float</code>,
<codeclass="inline">:decimal</code> or <codeclass="inline">nil</code>. The default is <codeclass="inline">nil</code>
meaning that the type auto-detected as either
an <codeclass="inline">integer</code> or a <codeclass="inline">float</code>.</p></li><li><p><codeclass="inline">:locale</code> is any locale returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>
or a <codeclass="inline">Cldr.LanguageTag.t</code>. The default is <ahref="Plausible.Cldr.html#get_locale/0"><codeclass="inline">Plausible.Cldr.get_locale/0</code></a>.</p></li></ul><h2id="scan/2-returns"class="section-heading">
<p>Number parsing is performed by <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.Parser.html#parse/2"><codeclass="inline">Cldr.Number.Parser.parse/2</code></a>
and any options provided are passed to that function.</p><h2id="scan/2-examples"class="section-heading">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">scan</span><spanclass="p"data-group-id="0478600523-5">(</span><spanclass="s">"The prize is 23"</span><spanclass="p"data-group-id="0478600523-5">)</span><spanclass="w">
</span><spanclass="p"data-group-id="0478600523-6">[</span><spanclass="s">"The prize is "</span><spanclass="p">,</span><spanclass="w"></span><spanclass="mi">23</span><spanclass="p"data-group-id="0478600523-6">]</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">scan</span><spanclass="p"data-group-id="1746242051-5">(</span><spanclass="s">"The prize is 23"</span><spanclass="p"data-group-id="1746242051-5">)</span><spanclass="w">
</span><spanclass="p"data-group-id="1746242051-6">[</span><spanclass="s">"The prize is "</span><spanclass="p">,</span><spanclass="w"></span><spanclass="mi">23</span><spanclass="p"data-group-id="1746242051-6">]</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">scan</span><spanclass="p"data-group-id="0478600523-7">(</span><spanclass="s">"The lottery number is 23 for the next draw"</span><spanclass="p"data-group-id="0478600523-7">)</span><spanclass="w">
</span><spanclass="p"data-group-id="0478600523-8">[</span><spanclass="s">"The lottery number is "</span><spanclass="p">,</span><spanclass="w"></span><spanclass="mi">23</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">" for the next draw"</span><spanclass="p"data-group-id="0478600523-8">]</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">scan</span><spanclass="p"data-group-id="1746242051-7">(</span><spanclass="s">"The lottery number is 23 for the next draw"</span><spanclass="p"data-group-id="1746242051-7">)</span><spanclass="w">
</span><spanclass="p"data-group-id="1746242051-8">[</span><spanclass="s">"The lottery number is "</span><spanclass="p">,</span><spanclass="w"></span><spanclass="mi">23</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">" for the next draw"</span><spanclass="p"data-group-id="1746242051-8">]</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">scan</span><spanclass="p"data-group-id="0478600523-9">(</span><spanclass="s">"The loss is -1.000 euros"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">locale</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"de"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">number</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:integer</span><spanclass="p"data-group-id="0478600523-9">)</span><spanclass="w">
</span><spanclass="p"data-group-id="0478600523-10">[</span><spanclass="s">"The loss is "</span><spanclass="p">,</span><spanclass="w"></span><spanclass="o">-</span><spanclass="mi">1000</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">" euros"</span><spanclass="p"data-group-id="0478600523-10">]</span></code></pre>
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">scan</span><spanclass="p"data-group-id="1746242051-9">(</span><spanclass="s">"The loss is -1.000 euros"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">locale</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"de"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">number</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:integer</span><spanclass="p"data-group-id="1746242051-9">)</span><spanclass="w">
</span><spanclass="p"data-group-id="1746242051-10">[</span><spanclass="s">"The loss is "</span><spanclass="p">,</span><spanclass="w"></span><spanclass="o">-</span><spanclass="mi">1000</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">" euros"</span><spanclass="p"data-group-id="1746242051-10">]</span></code></pre>
</section>
</section>
<sectionclass="detail"id="to_approx_string/2">
@ -832,21 +830,21 @@ and any options provided are passed to that function.</p><h2 id="scan/2-examples
<p>Formats a number and applies the <codeclass="inline">:approximately</code> format for
a locale and number system.</p><h2id="to_approx_string/2-arguments"class="section-heading">
<ul><li><p><codeclass="inline">number</code> is an integer, float or Decimal to be formatted</p></li><li><p><codeclass="inline">options</code> is a keyword list defining how the number is to be formatted.
See <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.html#to_string/3"><codeclass="inline">Cldr.Number.to_string/3</code></a> for a description of the available
<ul><li><p><codeclass="inline">number</code> is an integer, float or Decimal to be formatted</p></li><li><p><codeclass="inline">options</code> is a keyword list defining how the number is to be formatted.
See <ahref="#to_string/2"><codeclass="inline">Plausible.Cldr.Number.to_string/2</code></a> for a description of the available
<ul><li><p><codeclass="inline">number</code> is an integer, float or Decimal to be formatted</p></li><li><p><codeclass="inline">options</code> is a keyword list defining how the number is to be formatted.
See <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.html#to_string/3"><codeclass="inline">Cldr.Number.to_string/3</code></a> for a description of the available
<ul><li><p><codeclass="inline">number</code> is an integer, float or Decimal to be formatted</p></li><li><p><codeclass="inline">options</code> is a keyword list defining how the number is to be formatted.
See <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.html#to_string/3"><codeclass="inline">Cldr.Number.to_string/3</code></a> for a description of the available
<ul><li><p><codeclass="inline">number</code> is an integer, float or Decimal to be formatted</p></li><li><p><codeclass="inline">options</code> is a keyword list defining how the number is to be formatted.</p></li></ul><h2id="to_string/2-options"class="section-heading">
<ul><li><p><codeclass="inline">format</code>: the format style or a format string defining how the number is
formatted. See <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.Format.html"><codeclass="inline">Cldr.Number.Format</code></a> for how format strings can be constructed.
@ -1089,38 +1087,38 @@ with parameters <code class="inline">string</code> and <code class="inline">tag<
<codeclass="inline">:permille</code>, <codeclass="inline">:minus</code> or <codeclass="inline">:plus</code>. The function must return a string. The
function can be used to wrap format elements in HTML or other tags.</p></li></ul><h2id="to_string/2-locale-extensions-affecting-formatting"class="section-heading">
<p>A locale identifier can specify options that affect number formatting.
These options are:</p><ul><li><codeclass="inline">nu</code>: defines the number system to be used if none is specified by the <codeclass="inline">:number_system</code>
option to <ahref="#to_string/2"><codeclass="inline">to_string/2</code></a></li></ul><p>This key is part of the <ahref="https://unicode.org/reports/tr35/#u_Extension">u extension</a> and
that document should be consulted for details on how to construct a locale identifier with these
<p>Wrapping elements is particularly useful when formatting a number with a
currency symbol and the requirement is to have different HTML formatting
applied to the symbol than the number. For example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="8207969148-1">(</span><spanclass="mi">100</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:currency</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">currency</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:USD</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">wrapper</span><spanclass="p">:</span><spanclass="w"></span><spanclass="k"data-group-id="8207969148-2">fn</span><spanclass="w">
applied to the symbol than the number. For example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="6361932049-1">(</span><spanclass="mi">100</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:currency</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">currency</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:USD</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">wrapper</span><spanclass="p">:</span><spanclass="w"></span><spanclass="k"data-group-id="6361932049-2">fn</span><spanclass="w">
</span><spanclass="p"data-group-id="8207969148-3">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"<span class=</span><spanclass="se">\"</span><spanclass="s">symbol</span><spanclass="se">\"</span><spanclass="s">>$</span><span class=</span><spanclass="se">\"</span><spanclass="s">number</span><spanclass="se">\"</span><spanclass="s">>100.00</span>"</span><spanclass="p"data-group-id="8207969148-3">}</span></code></pre><p>It is also possible and recommended to use the <ahref="https://hexdocs.pm/phoenix_html/3.3.1/Phoenix.HTML.Tag.html#content_tag/3"><codeclass="inline">Phoenix.HTML.Tag.content_tag/3</code></a>
</span><spanclass="p"data-group-id="6361932049-3">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"<span class=</span><spanclass="se">\"</span><spanclass="s">symbol</span><spanclass="se">\"</span><spanclass="s">>$</span><span class=</span><spanclass="se">\"</span><spanclass="s">number</span><spanclass="se">\"</span><spanclass="s">>100.00</span>"</span><spanclass="p"data-group-id="6361932049-3">}</span></code></pre><p>It is also possible and recommended to use the <ahref="https://hexdocs.pm/phoenix_html/3.3.1/Phoenix.HTML.Tag.html#content_tag/3"><codeclass="inline">Phoenix.HTML.Tag.content_tag/3</code></a>
function if wrapping HTML tags since these will ensure HTML entities are
correctly encoded. For example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="1642798219-1">(</span><spanclass="mi">100</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:currency</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">currency</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:USD</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">wrapper</span><spanclass="p">:</span><spanclass="w"></span><spanclass="k"data-group-id="1642798219-2">fn</span><spanclass="w">
</span><spanclass="p"data-group-id="1642798219-6">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"<span class=</span><spanclass="se">\"</span><spanclass="s">symbol</span><spanclass="se">\"</span><spanclass="s">>$</span><span class=</span><spanclass="se">\"</span><spanclass="s">number</span><spanclass="se">\"</span><spanclass="s">>100.00</span>"</span><spanclass="p"data-group-id="1642798219-6">}</span></code></pre><p>When formatting a number the format is parsed into format elements that might include
</span><spanclass="p"data-group-id="8887866570-6">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"<span class=</span><spanclass="se">\"</span><spanclass="s">symbol</span><spanclass="se">\"</span><spanclass="s">>$</span><span class=</span><spanclass="se">\"</span><spanclass="s">number</span><spanclass="se">\"</span><spanclass="s">>100.00</span>"</span><spanclass="p"data-group-id="8887866570-6">}</span></code></pre><p>When formatting a number the format is parsed into format elements that might include
a currency symbol, a literal string, inserted text between a currency symbol and the
currency amount, a percent sign, the number itself and several other elements. In
some cases it is helpful to be apply specific formatting to each element.
@ -1129,92 +1127,92 @@ function as an argument. For each element of the format the wrapper function is
with two parameters: the format element as a string and an atom representing the
element type. The wrapper function is required to return a string that is then
inserted in the final formatted number.</p><h2id="to_string/2-returns"class="section-heading">
</span><spanclass="p"data-group-id="6239917978-12">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"1,244 US dollars"</span><spanclass="p"data-group-id="6239917978-12">}</span><spanclass="w">
</span><spanclass="p"data-group-id="1102705433-12">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"1,244 US dollars"</span><spanclass="p"data-group-id="1102705433-12">}</span><spanclass="w">
</span><spanclass="p"data-group-id="6239917978-15">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"one thousand two hundred thirty-four"</span><spanclass="p"data-group-id="6239917978-15">}</span><spanclass="w">
</span><spanclass="p"data-group-id="1102705433-15">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"one thousand two hundred thirty-four"</span><spanclass="p"data-group-id="1102705433-15">}</span><spanclass="w">
</span><spanclass="p"data-group-id="6239917978-16">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"one thousand two hundred and thirty-four"</span><spanclass="p"data-group-id="6239917978-16">}</span><spanclass="w">
</span><spanclass="p"data-group-id="1102705433-16">{</span><spanclass="ss">:ok</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"one thousand two hundred and thirty-four"</span><spanclass="p"data-group-id="1102705433-16">}</span><spanclass="w">
<p>An error tuple <codeclass="inline">{:error, reason}</code> will be returned if an error is detected.
The two most likely causes of an error return are:</p><ul><li>A format cannot be compiled. In this case the error tuple will look like:</li></ul><pre><codeclass="makeup elixir"translate="no"><spanclass="w"></span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="4552459677-1">(</span><spanclass="mi">12345</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"0#"</span><spanclass="p"data-group-id="4552459677-1">)</span><spanclass="w">
</span><spanclass="s">"Decimal format compiler: syntax error before: </span><spanclass="se">\"</span><spanclass="s">#</span><spanclass="se">\"</span><spanclass="s">"</span><spanclass="p"data-group-id="4552459677-3">}</span><spanclass="p"data-group-id="4552459677-2">}</span></code></pre><ul><li>The format style requested is not defined for the <codeclass="inline">locale</code> and
The two most likely causes of an error return are:</p><ul><li>A format cannot be compiled. In this case the error tuple will look like:</li></ul><pre><codeclass="makeup elixir"translate="no"><spanclass="w"></span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="9698764873-1">(</span><spanclass="mi">12345</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"0#"</span><spanclass="p"data-group-id="9698764873-1">)</span><spanclass="w">
</span><spanclass="s">"Decimal format compiler: syntax error before: </span><spanclass="se">\"</span><spanclass="s">#</span><spanclass="se">\"</span><spanclass="s">"</span><spanclass="p"data-group-id="9698764873-3">}</span><spanclass="p"data-group-id="9698764873-2">}</span></code></pre><ul><li>The format style requested is not defined for the <codeclass="inline">locale</code> and
<codeclass="inline">number_system</code>. This happens typically when the number system is
<codeclass="inline">:algorithmic</code> rather than the more common <codeclass="inline">:numeric</code>. In this case the error
</span><spanclass="s">"The locale :he with number system :hebr does not define a format :standard"</span><spanclass="p"data-group-id="1941539908-3">}</span><spanclass="p"data-group-id="1941539908-2">}</span></code></pre>
</span><spanclass="s">"The locale :he with number system :hebr does not define a format :standard"</span><spanclass="p"data-group-id="0524034526-3">}</span><spanclass="p"data-group-id="0524034526-2">}</span></code></pre>
<ul><li><p><codeclass="inline">number</code> is an integer, float or Decimal to be formatted</p></li><li><p><codeclass="inline">options</code> is a keyword list defining how the number is to be formatted. See
<ul><li><p><codeclass="inline">locale</code> is any valid locale name returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.Locale.html#new!/2"><codeclass="inline">Cldr.Locale.new!/2</code></a></p></li><li><p><codeclass="inline">system_name</code> is any number system name returned by
<ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_number_systems/0"><codeclass="inline">Cldr.known_number_systems/0</code></a> or a number system type
returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_number_system_types/0"><codeclass="inline">Cldr.known_number_system_types/0</code></a></p></li></ul><h2id="validate_number_system/2-examples"class="section-heading">
</span><spanclass="p"data-group-id="5492632522-4">{</span><spanclass="nc">Cldr.UnknownNumberSystemError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The number system :unknown is unknown"</span><spanclass="p"data-group-id="5492632522-4">}</span><spanclass="p"data-group-id="5492632522-3">}</span><spanclass="w">
</span><spanclass="p"data-group-id="1056364862-4">{</span><spanclass="nc">Cldr.UnknownNumberSystemError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The number system :unknown is unknown"</span><spanclass="p"data-group-id="1056364862-4">}</span><spanclass="p"data-group-id="1056364862-3">}</span><spanclass="w">
</span><spanclass="p"data-group-id="5492632522-5">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="5492632522-6">{</span><spanclass="nc">Cldr.InvalidLanguageError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The language </span><spanclass="se">\"</span><spanclass="s">zz</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="5492632522-6">}</span><spanclass="p"data-group-id="5492632522-5">}</span></code></pre>
</span><spanclass="p"data-group-id="1056364862-5">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="1056364862-6">{</span><spanclass="nc">Cldr.InvalidLanguageError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The language </span><spanclass="se">\"</span><spanclass="s">zz</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="1056364862-6">}</span><spanclass="p"data-group-id="1056364862-5">}</span></code></pre>
</section>
</section>
@ -1352,7 +1350,7 @@ returned by <a href="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_number_sy
<pclass="built-using">
Built using
<ahref="https://github.com/elixir-lang/ex_doc"title="ExDoc"target="_blank"rel="help noopener"translate="no">ExDoc</a> (v0.29.4) for the
<ahref="https://github.com/elixir-lang/ex_doc"title="ExDoc"target="_blank"rel="help noopener"translate="no">ExDoc</a> (v0.30.3) for the
<p>Functions to implement the number system rule-based-number-format rules of CLDR.</p><p>These rules are defined only on the "und" locale and represent specialised
number formatting.</p><p>The standard public API for RBNF is via the <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.html#to_string/2"><codeclass="inline">Cldr.Number.to_string/2</code></a> function.</p><p>The functions on this module are defined at compile time based upon the RBNF rules
defined in the Unicode CLDR data repository. Available rules are identified by:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.NumberSystem</span><spanclass="o">.</span><spanclass="n">rule_sets</span><spanclass="p"data-group-id="3555658091-1">(</span><spanclass="ss">:und</span><spanclass="p"data-group-id="3555658091-1">)</span><spanclass="w">
defined in the Unicode CLDR data repository. Available rules are identified by:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.NumberSystem</span><spanclass="o">.</span><spanclass="n">rule_sets</span><spanclass="p"data-group-id="7027369616-1">(</span><spanclass="ss">:und</span><spanclass="p"data-group-id="7027369616-1">)</span><spanclass="w">
</span><spanclass="p"data-group-id="3555658091-3">]</span></code></pre><p>A rule can then be invoked on an available rule_set. For example</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.NumberSystem</span><spanclass="o">.</span><spanclass="n">roman_upper</span><spanclass="p"data-group-id="1329052689-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">:und</span><spanclass="p"data-group-id="1329052689-1">)</span><spanclass="w">
</span><spanclass="s">"CXXIII"</span></code></pre><p>This particular call is equivalent to the call through the public API of:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="3196197870-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:roman</span><spanclass="p"data-group-id="3196197870-1">)</span><spanclass="w">
</span><spanclass="p"data-group-id="7027369616-3">]</span></code></pre><p>A rule can then be invoked on an available rule_set. For example</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.NumberSystem</span><spanclass="o">.</span><spanclass="n">roman_upper</span><spanclass="p"data-group-id="6620666360-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">:und</span><spanclass="p"data-group-id="6620666360-1">)</span><spanclass="w">
</span><spanclass="s">"CXXIII"</span></code></pre><p>This particular call is equivalent to the call through the public API of:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="4796083374-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:roman</span><spanclass="p"data-group-id="4796083374-1">)</span><spanclass="w">
<p>Functions to implement the ordinal rule-based-number-format rules of CLDR.</p><p>As CLDR notes, the data is incomplete or non-existent for many languages. It
is considered complete for English however.</p><p>The standard public API for RBNF is via the <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.html#to_string/2"><codeclass="inline">Cldr.Number.to_string/2</code></a> function.</p><p>The functions on this module are defined at compile time based upon the RBNF rules
defined in the Unicode CLDR data repository. Available rules are identified by:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.Ordinal</span><spanclass="o">.</span><spanclass="n">rule_sets</span><spanclass="p"data-group-id="4991249940-1">(</span><spanclass="ss">:en</span><spanclass="p"data-group-id="4991249940-1">)</span><spanclass="w">
defined in the Unicode CLDR data repository. Available rules are identified by:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.Ordinal</span><spanclass="o">.</span><spanclass="n">rule_sets</span><spanclass="p"data-group-id="8660097642-1">(</span><spanclass="ss">:en</span><spanclass="p"data-group-id="8660097642-1">)</span><spanclass="w">
</span><spanclass="p"data-group-id="4991249940-5">]</span></code></pre><p>A rule can then be invoked on an available rule_set. For example</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.Ordinal</span><spanclass="o">.</span><spanclass="n">digits_ordinal</span><spanclass="p"data-group-id="6318036879-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">:en</span><spanclass="p"data-group-id="6318036879-1">)</span><spanclass="w">
</span><spanclass="s">"123rd"</span></code></pre><p>This call is equivalent to the call through the public API of:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="5649167437-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:ordinal</span><spanclass="p"data-group-id="5649167437-1">)</span><spanclass="w">
</span><spanclass="p"data-group-id="8660097642-5">]</span></code></pre><p>A rule can then be invoked on an available rule_set. For example</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.Ordinal</span><spanclass="o">.</span><spanclass="n">digits_ordinal</span><spanclass="p"data-group-id="9747445163-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">:en</span><spanclass="p"data-group-id="9747445163-1">)</span><spanclass="w">
</span><spanclass="s">"123rd"</span></code></pre><p>This call is equivalent to the call through the public API of:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="1129579396-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:ordinal</span><spanclass="p"data-group-id="1129579396-1">)</span><spanclass="w">
<p>Functions to implement the spellout rule-based-number-format rules of CLDR.</p><p>As CLDR notes, the data is incomplete or non-existent for many languages. It
is considered complete for English however.</p><p>The standard public API for RBNF is via the <ahref="https://hexdocs.pm/ex_cldr_numbers/2.31.3/Cldr.Number.html#to_string/2"><codeclass="inline">Cldr.Number.to_string/2</code></a> function.</p><p>The functions on this module are defined at compile time based upon the RBNF rules
defined in the Unicode CLDR data repository. Available rules are identified by:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.Spellout</span><spanclass="o">.</span><spanclass="n">rule_sets</span><spanclass="p"data-group-id="9631009264-1">(</span><spanclass="s">"en"</span><spanclass="p"data-group-id="9631009264-1">)</span><spanclass="w">
defined in the Unicode CLDR data repository. Available rules are identified by:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.Spellout</span><spanclass="o">.</span><spanclass="n">rule_sets</span><spanclass="p"data-group-id="3623195740-1">(</span><spanclass="s">"en"</span><spanclass="p"data-group-id="3623195740-1">)</span><spanclass="w">
</span><spanclass="p"data-group-id="9631009264-3">]</span></code></pre><p>A rule can then be invoked on an available rule_set. For example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.Spellout</span><spanclass="o">.</span><spanclass="n">spellout_ordinal</span><spanclass="p"data-group-id="8566023409-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"en"</span><spanclass="p"data-group-id="8566023409-1">)</span><spanclass="w">
</span><spanclass="s">"one hundred twenty-third"</span></code></pre><p>This call is equivalent to the call through the public API of:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="5848316522-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:spellout</span><spanclass="p"data-group-id="5848316522-1">)</span><spanclass="w">
</span><spanclass="p"data-group-id="3623195740-3">]</span></code></pre><p>A rule can then be invoked on an available rule_set. For example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Rbnf.Spellout</span><spanclass="o">.</span><spanclass="n">spellout_ordinal</span><spanclass="p"data-group-id="5783831419-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"en"</span><spanclass="p"data-group-id="5783831419-1">)</span><spanclass="w">
</span><spanclass="s">"one hundred twenty-third"</span></code></pre><p>This call is equivalent to the call through the public API of:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr.Number</span><spanclass="o">.</span><spanclass="n">to_string</span><spanclass="p"data-group-id="4903623900-1">(</span><spanclass="mi">123</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:spellout</span><spanclass="p"data-group-id="4903623900-1">)</span><spanclass="w">
<ul><li><p><codeclass="inline">string</code> is any <codeclass="inline">String.t</code> or a 2-element list
of <codeclass="inline">String.t</code> between which the ellipsis is inserted.</p></li><li><p><codeclass="inline">backend</code> is any module that includes <codeclass="inline">use Cldr</code> and therefore
@ -615,10 +613,10 @@ is a <a href="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html"><code class="inline">
Note that <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#default_backend!/0"><codeclass="inline">Cldr.default_backend!/0</code></a> will raise an exception if
no <codeclass="inline">:default_backend</code> is configured under the <codeclass="inline">:ex_cldr</code> key in
<codeclass="inline">config.exs</code>.</p></li><li><p><codeclass="inline">options</code> is a keyword list of options</p></li></ul><h2id="ellipsis/2-options"class="section-heading">
<ul><li><p><codeclass="inline">:locale</code> is any valid locale name returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>.
The default is <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#get_locale/0"><codeclass="inline">Cldr.get_locale/0</code></a>.</p></li><li><p><codeclass="inline">:location</code> determines where to place the ellipsis. The options are
@ -627,21 +625,21 @@ The default is <a href="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#get_locale/0
of two strings) and <codeclass="inline">:before</code>.</p></li><li><p><codeclass="inline">:format</code> formats based upon whether the ellipsis
is inserted between words or sentences. The valid options are
<codeclass="inline">:word</code> or <codeclass="inline">:sentence</code>. The default is <codeclass="inline">:sentence</code>.</p></li></ul><h2id="ellipsis/2-examples"class="section-heading">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr</span><spanclass="o">.</span><spanclass="n">ellipsis</span><spanclass="w"></span><spanclass="p"data-group-id="0172763069-1">[</span><spanclass="s">"And furthermore"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"there is much to be done"</span><spanclass="p"data-group-id="0172763069-1">]</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">locale</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:ja</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr</span><spanclass="o">.</span><spanclass="n">ellipsis</span><spanclass="w"></span><spanclass="p"data-group-id="8402678394-1">[</span><spanclass="s">"And furthermore"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"there is much to be done"</span><spanclass="p"data-group-id="8402678394-1">]</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">locale</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:ja</span><spanclass="w">
</span><spanclass="s">"And furthermore…there is much to be done"</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr</span><spanclass="o">.</span><spanclass="n">ellipsis</span><spanclass="w"></span><spanclass="p"data-group-id="0172763069-2">[</span><spanclass="s">"And furthermore"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"there is much to be done"</span><spanclass="p"data-group-id="0172763069-2">]</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">locale</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:ja</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:word</span><spanclass="w">
</span><spanclass="gp unselectable">iex></span><spanclass="nc">Plausible.Cldr</span><spanclass="o">.</span><spanclass="n">ellipsis</span><spanclass="w"></span><spanclass="p"data-group-id="8402678394-2">[</span><spanclass="s">"And furthermore"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"there is much to be done"</span><spanclass="p"data-group-id="8402678394-2">]</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">locale</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:ja</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">format</span><spanclass="p">:</span><spanclass="w"></span><spanclass="ss">:word</span><spanclass="w">
</span><spanclass="s">"And furthermore … there is much to be done"</span></code></pre>
</section>
</section>
@ -672,28 +670,28 @@ is inserted between words or sentences. The valid options are
<p>Return the current locale to be used for <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html"><codeclass="inline">Cldr</code></a> functions that
take an optional locale parameter for which a locale is not supplied.</p><h2id="get_locale/0-example"class="section-heading">
@ -891,17 +889,17 @@ with <a href="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html"><code class="inline">
<p>Returns either the <codeclass="inline">locale_name</code> or <codeclass="inline">false</code> based upon
whether the locale name is configured in <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html"><codeclass="inline">Cldr</code></a>.</p><p>This is helpful when building a list of <codeclass="inline">or</code> expressions
to return the first known locale name from a list.</p><h2id="known_locale_name/1-arguments"class="section-heading">
<ul><li><codeclass="inline">locale</code> is any valid locale name returned by <ahref="#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a></li></ul><h2id="known_locale_name?/1-examples"class="section-heading">
@ -1000,13 +998,13 @@ in this module or in <a href="https://hexdocs.pm/gettext/0.22.3/Gettext.html"><c
<sectionclass="docstring">
<p>Returns a list of atoms representing the number systems types known to <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html"><codeclass="inline">Cldr</code></a>.</p><h2id="known_number_system_types/0-example"class="section-heading">
<ul><li><codeclass="inline">locale</code> is any valid locale name returned by <ahref="#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a></li></ul><h2id="known_rbnf_locale_name?/1-examples"class="section-heading">
<ul><li><codeclass="inline">locale</code> is any valid locale name returned by <ahref="#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a>
or a <codeclass="inline">t:Cldr.LanguageTag</code> struct returned by <ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a></li></ul><p>See <ahref="https://tools.ietf.org/html/rfc5646">rfc5646</a> for the specification
of a language tag.</p><h2id="put_locale/1-examples"class="section-heading">
</span><spanclass="s">"Expected a BCP47 language tag. Could not parse the remaining </span><spanclass="se">\"</span><spanclass="s">!</span><spanclass="se">\"</span><spanclass="s"> starting at position 15"</span><spanclass="p"data-group-id="8371184248-12">}</span><spanclass="p"data-group-id="8371184248-11">}</span></code></pre>
</span><spanclass="s">"Expected a BCP47 language tag. Could not parse the remaining </span><spanclass="se">\"</span><spanclass="s">!</span><spanclass="se">\"</span><spanclass="s"> starting at position 15"</span><spanclass="p"data-group-id="6006752017-12">}</span><spanclass="p"data-group-id="6006752017-11">}</span></code></pre>
</section>
</section>
<sectionclass="detail"id="quote/2">
@ -1294,23 +1292,23 @@ of a language tag.</p><h2 id="put_locale/1-examples" class="section-heading">
</div>
<p>Add locale-specific quotation marks around a string.</p><h2id="quote/2-arguments"class="section-heading">
<ul><li><p><codeclass="inline">string</code> is any valid Elixir string</p></li><li><p><codeclass="inline">options</code> is a keyword list of options</p></li></ul><h2id="quote/2-options"class="section-heading">
<ul><li><codeclass="inline">locale</code> is any valid locale name returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>.
The default is <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#get_locale/0"><codeclass="inline">Cldr.get_locale/0</code></a></li></ul><h2id="quote/2-examples"class="section-heading">
<ul><li><codeclass="inline">locale</code> is any valid locale name returned by <ahref="#known_locale_names/0"><codeclass="inline">Plausible.Cldr.known_locale_names/0</code></a>
or a <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.LanguageTag.html"><codeclass="inline">Cldr.LanguageTag</code></a> struct returned by <ahref="Plausible.Cldr.Locale.html#new!/1"><codeclass="inline">Plausible.Cldr.Locale.new!/1</code></a></li></ul><h2id="validate_locale/1-returns"class="section-heading">
</span><spanclass="p"data-group-id="4371581038-18">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="4371581038-19">{</span><spanclass="nc">Cldr.InvalidLanguageError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The language </span><spanclass="se">\"</span><spanclass="s">zzz</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="4371581038-19">}</span><spanclass="p"data-group-id="4371581038-18">}</span></code></pre>
</span><spanclass="p"data-group-id="5778262213-18">{</span><spanclass="ss">:error</span><spanclass="p">,</span><spanclass="w"></span><spanclass="p"data-group-id="5778262213-19">{</span><spanclass="nc">Cldr.InvalidLanguageError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The language </span><spanclass="se">\"</span><spanclass="s">zzz</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="5778262213-19">}</span><spanclass="p"data-group-id="5778262213-18">}</span></code></pre>
</span><spanclass="p"data-group-id="0548467872-4">{</span><spanclass="nc">Cldr.UnknownNumberSystemTypeError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The number system type :latn is unknown"</span><spanclass="p"data-group-id="0548467872-4">}</span><spanclass="w">
</span><spanclass="p"data-group-id="4482289134-4">{</span><spanclass="nc">Cldr.UnknownNumberSystemTypeError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The number system type :latn is unknown"</span><spanclass="p"data-group-id="4482289134-4">}</span><spanclass="w">
</span><spanclass="p"data-group-id="0548467872-6">{</span><spanclass="nc">Cldr.UnknownNumberSystemTypeError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The number system type </span><spanclass="se">\"</span><spanclass="s">bork</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="0548467872-6">}</span><spanclass="w">
</span><spanclass="p"data-group-id="4482289134-6">{</span><spanclass="nc">Cldr.UnknownNumberSystemTypeError</span><spanclass="p">,</span><spanclass="w"></span><spanclass="s">"The number system type </span><spanclass="se">\"</span><spanclass="s">bork</span><spanclass="se">\"</span><spanclass="s"> is invalid"</span><spanclass="p"data-group-id="4482289134-6">}</span><spanclass="w">
<ul><li><p><codeclass="inline">locale</code> is any valid locale name returned by <ahref="https://hexdocs.pm/ex_cldr/2.37.2/Cldr.html#known_locale_names/1"><codeclass="inline">Cldr.known_locale_names/1</code></a>.</p></li><li><p><codeclass="inline">fun</code> is any 0-arity function or function capture.</p></li></ul><h2id="with_locale/2-returns"class="section-heading">
<ul><li><p>The value returned by the function <codeclass="inline">fun/0</code> or</p></li><li><p><codeclass="inline">{:error, {exception, reason}}</code> if the locale is invalid or</p></li><li><p>raises an exception if the current locale cannot be
identified.</p></li></ul>
@ -1664,7 +1662,7 @@ identified.</p></li></ul>
<pclass="built-using">
Built using
<ahref="https://github.com/elixir-lang/ex_doc"title="ExDoc"target="_blank"rel="help noopener"translate="no">ExDoc</a> (v0.29.4) for the
<ahref="https://github.com/elixir-lang/ex_doc"title="ExDoc"target="_blank"rel="help noopener"translate="no">ExDoc</a> (v0.30.3) for the
@ -443,9 +442,8 @@ pool to disconnect within the given interval.</p></div>
<h1class="section-heading">
<aclass="hover-link"href="#functions">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
</a>
Functions
</a>
</h1>
<divclass="functions-list">
<sectionclass="detail"id="aggregate/3">
@ -818,23 +816,23 @@ pool to disconnect within the given interval.</p><p>See <a href="https://hexdocs
<sectionclass="docstring">
<p>Similar to <codeclass="inline">insert_all/2</code> but with the following differences:</p><ul><li>accepts rows as streams or lists</li><li>sends rows as a chunked request</li><li>doesn't autogenerate ids or does any other preprocessing</li></ul><p>Example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="nc">Repo</span><spanclass="o">.</span><spanclass="n">query!</span><spanclass="p"data-group-id="1129453865-1">(</span><spanclass="s">"create table ecto_ch_demo(a UInt64, b String) engine Null"</span><spanclass="p"data-group-id="1129453865-1">)</span><spanclass="w">
<p>Similar to <codeclass="inline">insert_all/2</code> but with the following differences:</p><ul><li>accepts rows as streams or lists</li><li>sends rows as a chunked request</li><li>doesn't autogenerate ids or does any other preprocessing</li></ul><p>Example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="nc">Repo</span><spanclass="o">.</span><spanclass="n">query!</span><spanclass="p"data-group-id="0950373909-1">(</span><spanclass="s">"create table ecto_ch_demo(a UInt64, b String) engine Null"</span><spanclass="p"data-group-id="0950373909-1">)</span><spanclass="w">
@ -123,9 +123,8 @@ outside of the main application supervision tree.</p>
<h1class="section-heading">
<aclass="hover-link"href="#summary">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
Summary
</a>
Summary
</h1>
<divclass="summary-functions summary">
<h2>
@ -558,9 +557,8 @@ pool to disconnect within the given interval.</p></div>
<h1class="section-heading">
<aclass="hover-link"href="#functions">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
</a>
Functions
</a>
</h1>
<divclass="functions-list">
<sectionclass="detail"id="aggregate/3">
@ -1125,23 +1123,23 @@ pool to disconnect within the given interval.</p><p>See <a href="https://hexdocs
<sectionclass="docstring">
<p>Similar to <ahref="#insert_all/2"><codeclass="inline">insert_all/2</code></a> but with the following differences:</p><ul><li>accepts rows as streams or lists</li><li>sends rows as a chunked request</li><li>doesn't autogenerate ids or does any other preprocessing</li></ul><p>Example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="nc">Repo</span><spanclass="o">.</span><spanclass="n">query!</span><spanclass="p"data-group-id="3342693743-1">(</span><spanclass="s">"create table ecto_ch_demo(a UInt64, b String) engine Null"</span><spanclass="p"data-group-id="3342693743-1">)</span><spanclass="w">
<p>Similar to <ahref="#insert_all/2"><codeclass="inline">insert_all/2</code></a> but with the following differences:</p><ul><li>accepts rows as streams or lists</li><li>sends rows as a chunked request</li><li>doesn't autogenerate ids or does any other preprocessing</li></ul><p>Example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="nc">Repo</span><spanclass="o">.</span><spanclass="n">query!</span><spanclass="p"data-group-id="6303628669-1">(</span><spanclass="s">"create table ecto_ch_demo(a UInt64, b String) engine Null"</span><spanclass="p"data-group-id="6303628669-1">)</span><spanclass="w">
@ -181,9 +180,8 @@ and MaxMind license key.</p></div>
<h1class="section-heading">
<aclass="hover-link"href="#functions">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
</a>
Functions
</a>
</h1>
<divclass="functions-list">
<sectionclass="detail"id="await_loader/0">
@ -228,13 +226,13 @@ Functions
<sectionclass="docstring">
<p>Returns geodatabase type.</p><p>Used for deciding whether to show the DB-IP disclaimer or not.</p><h2id="database_type/0-examples"class="section-heading">
<p> In the case of a DB-IP database:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="n">database_type</span><spanclass="p"data-group-id="1941945109-1">(</span><spanclass="p"data-group-id="1941945109-1">)</span><spanclass="w">
</span><spanclass="s">"DBIP-City-Lite"</span></code></pre><p> In the case of a MaxMind database:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="n">database_type</span><spanclass="p"data-group-id="2153655394-1">(</span><spanclass="p"data-group-id="2153655394-1">)</span><spanclass="w">
<p> In the case of a DB-IP database:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="n">database_type</span><spanclass="p"data-group-id="7520102509-1">(</span><spanclass="p"data-group-id="7520102509-1">)</span><spanclass="w">
</span><spanclass="s">"DBIP-City-Lite"</span></code></pre><p> In the case of a MaxMind database:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="n">database_type</span><spanclass="p"data-group-id="5950548924-1">(</span><spanclass="p"data-group-id="5950548924-1">)</span><spanclass="w">
<ul><li><p><codeclass="inline">:path</code> - the path to the .mmdb database local file. When present,
<codeclass="inline">:license_key</code> and <codeclass="inline">:edition</code> are not required.</p></li><li><p><codeclass="inline">:license_key</code> - the <ahref="https://support.maxmind.com/hc/en-us/articles/4407111582235-Generate-a-License-Key">license key</a>
from MaxMind to authenticate requests to MaxMind.</p></li><li><p><codeclass="inline">:edition</code> - the name of the MaxMind database to be downloaded from MaxMind
servers. Defaults to <codeclass="inline">GeoLite2-City</code>.</p></li><li><p><codeclass="inline">:async</code> - when used, configures the database loading to run
<p> Loading from a local file:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="n">load_db</span><spanclass="p"data-group-id="3877912308-1">(</span><spanclass="ss">path</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"/etc/plausible/dbip-city.mmdb"</span><spanclass="p"data-group-id="3877912308-1">)</span><spanclass="w">
</span><spanclass="ss">:ok</span></code></pre><p> Downloading a MaxMind DB (this license key is no longer active):</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="n">load_db</span><spanclass="p"data-group-id="2123866960-1">(</span><spanclass="ss">license_key</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"LNpsJCCKPis6XvBP"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">edition</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"GeoLite2-City"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">async</span><spanclass="p">:</span><spanclass="w"></span><spanclass="no">true</span><spanclass="p"data-group-id="2123866960-1">)</span><spanclass="w">
<p> Loading from a local file:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="n">load_db</span><spanclass="p"data-group-id="4783078513-1">(</span><spanclass="ss">path</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"/etc/plausible/dbip-city.mmdb"</span><spanclass="p"data-group-id="4783078513-1">)</span><spanclass="w">
</span><spanclass="ss">:ok</span></code></pre><p> Downloading a MaxMind DB (this license key is no longer active):</p><pre><codeclass="makeup elixir"translate="no"><spanclass="gp unselectable">iex></span><spanclass="n">load_db</span><spanclass="p"data-group-id="4996437076-1">(</span><spanclass="ss">license_key</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"LNpsJCCKPis6XvBP"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">edition</span><spanclass="p">:</span><spanclass="w"></span><spanclass="s">"GeoLite2-City"</span><spanclass="p">,</span><spanclass="w"></span><spanclass="ss">async</span><spanclass="p">:</span><spanclass="w"></span><spanclass="no">true</span><spanclass="p"data-group-id="4996437076-1">)</span><spanclass="w">
</span><spanclass="s">"pt-BR"</span><spanclass="w"></span><spanclass="p">=></span><spanclass="w"></span><spanclass="s">"América do Norte"</span><spanclass="p">,</span><spanclass="w">
@ -549,9 +548,8 @@ pool to disconnect within the given interval.</p></div>
<h1class="section-heading">
<aclass="hover-link"href="#functions">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
</a>
Functions
</a>
</h1>
<divclass="functions-list">
<sectionclass="detail"id="aggregate/3">
@ -1116,23 +1114,23 @@ pool to disconnect within the given interval.</p><p>See <a href="https://hexdocs
<sectionclass="docstring">
<p>Similar to <ahref="#insert_all/2"><codeclass="inline">insert_all/2</code></a> but with the following differences:</p><ul><li>accepts rows as streams or lists</li><li>sends rows as a chunked request</li><li>doesn't autogenerate ids or does any other preprocessing</li></ul><p>Example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="nc">Repo</span><spanclass="o">.</span><spanclass="n">query!</span><spanclass="p"data-group-id="5468370737-1">(</span><spanclass="s">"create table ecto_ch_demo(a UInt64, b String) engine Null"</span><spanclass="p"data-group-id="5468370737-1">)</span><spanclass="w">
<p>Similar to <ahref="#insert_all/2"><codeclass="inline">insert_all/2</code></a> but with the following differences:</p><ul><li>accepts rows as streams or lists</li><li>sends rows as a chunked request</li><li>doesn't autogenerate ids or does any other preprocessing</li></ul><p>Example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="nc">Repo</span><spanclass="o">.</span><spanclass="n">query!</span><spanclass="p"data-group-id="6970928063-1">(</span><spanclass="s">"create table ecto_ch_demo(a UInt64, b String) engine Null"</span><spanclass="p"data-group-id="6970928063-1">)</span><spanclass="w">
@ -549,9 +548,8 @@ pool to disconnect within the given interval.</p></div>
<h1class="section-heading">
<aclass="hover-link"href="#functions">
<iclass="ri-link-m"aria-hidden="true"></i>
<spanclass="sr-only">Link to this section</span>
</a>
Functions
</a>
</h1>
<divclass="functions-list">
<sectionclass="detail"id="aggregate/3">
@ -1116,23 +1114,23 @@ pool to disconnect within the given interval.</p><p>See <a href="https://hexdocs
<sectionclass="docstring">
<p>Similar to <ahref="#insert_all/2"><codeclass="inline">insert_all/2</code></a> but with the following differences:</p><ul><li>accepts rows as streams or lists</li><li>sends rows as a chunked request</li><li>doesn't autogenerate ids or does any other preprocessing</li></ul><p>Example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="nc">Repo</span><spanclass="o">.</span><spanclass="n">query!</span><spanclass="p"data-group-id="0223554293-1">(</span><spanclass="s">"create table ecto_ch_demo(a UInt64, b String) engine Null"</span><spanclass="p"data-group-id="0223554293-1">)</span><spanclass="w">
<p>Similar to <ahref="#insert_all/2"><codeclass="inline">insert_all/2</code></a> but with the following differences:</p><ul><li>accepts rows as streams or lists</li><li>sends rows as a chunked request</li><li>doesn't autogenerate ids or does any other preprocessing</li></ul><p>Example:</p><pre><codeclass="makeup elixir"translate="no"><spanclass="nc">Repo</span><spanclass="o">.</span><spanclass="n">query!</span><spanclass="p"data-group-id="4336514087-1">(</span><spanclass="s">"create table ecto_ch_demo(a UInt64, b String) engine Null"</span><spanclass="p"data-group-id="4336514087-1">)</span><spanclass="w">