Current section
Files
Jump to
Current section
Files
gen/docs/validator/string/index.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width" />
<title>validator/string - validator</title>
<link rel="stylesheet" href="../../index.css" type="text/css" />
</head>
<body>
<header class="page-header">
<h2>
validator<!-- - -->
</h2>
</header>
<div class="page">
<nav class="sidebar">
<a class="sidebar-toggle" href="#">
<svg
aria-hidden="true"
focusable="false"
data-prefix="fas"
data-icon="bars"
class="svg-inline--fa fa-bars fa-w-14"
role="img"
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 448 512"
>
<path
fill="#fff"
d="M16 132h416c8.837 0 16-7.163 16-16V76c0-8.837-7.163-16-16-16H16C7.163 60 0 67.163 0 76v40c0 8.837 7.163 16 16 16zm0 160h416c8.837 0 16-7.163 16-16v-40c0-8.837-7.163-16-16-16H16c-8.837 0-16 7.163-16 16v40c0 8.837 7.163 16 16 16zm0 160h416c8.837 0 16-7.163 16-16v-40c0-8.837-7.163-16-16-16H16c-8.837 0-16 7.163-16 16v40c0 8.837 7.163 16 16 16z"
></path>
</svg>
</a>
<h2>Pages</h2>
<ul>
<li><a href="../../index.html">README</a></li>
</ul>
<h2>Modules</h2>
<ul>
<li><a href="../../validator/">validator</a></li>
<li><a href="../../validator/common/">validator/common</a></li>
<li><a href="../../validator/int/">validator/int</a></li>
<li><a href="../../validator/list/">validator/list</a></li>
<li><a href="../../validator/option/">validator/option</a></li>
<li><a href="../../validator/string/">validator/string</a></li>
</ul>
<h2>Functions</h2>
<ul>
<li><a href="#is_email">is_email</a></li>
<li><a href="#is_float">is_float</a></li>
<li><a href="#is_int">is_int</a></li>
<li><a href="#is_not_empty">is_not_empty</a></li>
<li><a href="#max_length">max_length</a></li>
<li><a href="#min_length">min_length</a></li>
</ul>
</nav>
<div class="content">
<h1 class="module-name">validator/string</h1>
<section class="module-members">
<a href="#module-functions">
<h1 id="module-functions" class="module-member-kind">Functions</h1>
</a>
<div class="member">
<a href="#is_email">
<h2 id="is_email" class="member-name">
is_email
</h2>
</a>
<pre>pub fn is_email(
error: a,
) -> fn(String) -> Result(String, tuple(a, List(a)))</pre>
<div class="rendered-markdown"><p>Validate if a string is an email.</p>
<p>This checks if a string follows a simple pattern <code>_@_</code>.</p>
</div>
</div>
<div class="member">
<a href="#is_float">
<h2 id="is_float" class="member-name">
is_float
</h2>
</a>
<pre>pub fn is_float(
error: a,
) -> fn(String) -> Result(Float, tuple(a, List(a)))</pre>
<div class="rendered-markdown"><p>Validate if a string parses to an Float. Returns the Float if so.</p>
</div>
</div>
<div class="member">
<a href="#is_int">
<h2 id="is_int" class="member-name">
is_int
</h2>
</a>
<pre>pub fn is_int(
error: a,
) -> fn(String) -> Result(Int, tuple(a, List(a)))</pre>
<div class="rendered-markdown"><p>Validate if a string parses to an Int. Returns the Int if so.</p>
</div>
</div>
<div class="member">
<a href="#is_not_empty">
<h2 id="is_not_empty" class="member-name">
is_not_empty
</h2>
</a>
<pre>pub fn is_not_empty(
error: a,
) -> fn(String) -> Result(String, tuple(a, List(a)))</pre>
<div class="rendered-markdown"><p>Validate if a string is not empty</p>
</div>
</div>
<div class="member">
<a href="#max_length">
<h2 id="max_length" class="member-name">
max_length
</h2>
</a>
<pre>pub fn max_length(
error: a,
max: Int,
) -> fn(String) -> Result(String, tuple(a, List(a)))</pre>
<div class="rendered-markdown"><p>Validate the max length of a string</p>
</div>
</div>
<div class="member">
<a href="#min_length">
<h2 id="min_length" class="member-name">
min_length
</h2>
</a>
<pre>pub fn min_length(
error: a,
min: Int,
) -> fn(String) -> Result(String, tuple(a, List(a)))</pre>
<div class="rendered-markdown"><p>Validate the min length of a string</p>
</div>
</div>
</section>
</div>
</div>
<footer class="pride" onclick="document.querySelector('.pride').classList.toggle('show')">
<div class="blue">Lucy</div>
<div class="pink">says</div>
<div class="white">trans</div>
<div class="pink">rights</div>
<div class="blue">✨</div>
<a>✨</a>
</footer>
</body>
</html>