Deploying to stdlib-docs from @ b51d64a 🚀

snowball-lang · Dec 25, 2023 · 541a3fd · 541a3fd
1 parent bd36bf7
commit 541a3fd
Show file tree

Hide file tree

Showing 556 changed files with 12,772 additions and 6,550 deletions.
diff --git a/std.html b/std.html
@@ -0,0 +1,34 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Root</title>
+    <link rel="stylesheet" href="https://snowball-lang.github.io/autodoc-styles/styles.css">
+
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/atom-one-light.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/2.1.0/showdown.min.js" integrity="sha512-LhccdVNGe2QMEfI3x4DVV3ckMRe36TfydKss6mJpdHjNFiV07dFpS2xzeZedptKZrwxfICJpez09iNioiSZ3hA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://snowball-lang.github.io/autodoc-styles/md2html.js"></script>
+
+    <script src="https://snowball-lang.github.io/autodoc-styles/highlight.min.js"></script>
+
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Poppins:wght@400;500;600;700&display=swap" rel="stylesheet">
+
+    <base href="/snowball/">
+</head>
+<body>
+    <sidenav>
+        <h1 style="display: flex; align-items: center;">
+            std <span class="tag">version 1.0.0</span>
+        </h1>
+        <hr />
+        <a href="std.html">&lt; Go Back</a> 
+    </sidenav>
+    <main>
+        <h1>Modules in std</h1><hr/><div class="doc"><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/c_bindings.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">c_bindings</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/__winter_wonderland__.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">__winter_wonderland__</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/asserts.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">asserts</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/opt.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">opt</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/env.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">env</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/tuples.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">tuples</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/io.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">io</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/ptr.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">ptr</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/fs.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">fs</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/math.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">math</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/std.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">std</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/sl.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">sl</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/iter.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">iter</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/map.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">map</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/panics.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">panics</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/chars.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">chars</h1></a></div><br/><h1 style="font-size: 25px;">Modules in fs</h1><br/><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/fs/file.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">file</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/fs/path.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">path</h1></a></div><br/><h1 style="font-size: 25px;">Modules in internal</h1><br/><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/internal/preload.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">preload</h1></a></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/internal/integers.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">integers</h1></a></div>
+    </main>
+</body>
+</html>
diff --git a/std/__winter_wonderland__.html b/std/__winter_wonderland__.html
@@ -0,0 +1,34 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+    <title>std::__winter_wonderland__</title>
+    <link rel="stylesheet" href="https://snowball-lang.github.io/autodoc-styles/styles.css">
+
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/atom-one-light.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/2.1.0/showdown.min.js" integrity="sha512-LhccdVNGe2QMEfI3x4DVV3ckMRe36TfydKss6mJpdHjNFiV07dFpS2xzeZedptKZrwxfICJpez09iNioiSZ3hA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://snowball-lang.github.io/autodoc-styles/md2html.js"></script>
+
+    <script src="https://snowball-lang.github.io/autodoc-styles/highlight.min.js"></script>
+
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Poppins:wght@400;500;600;700&display=swap" rel="stylesheet">
+
+    <base href="/snowball/">
+</head>
+<body>
+    <sidenav>
+        <h1 style="display: flex; align-items: center;">
+            std::__winter_wonderland__ <span class="tag">version 1.0.0</span>
+        </h1>
+        <hr />
+        <a href="std/__winter_wonderland__.html">&lt; Go Back</a> 
+    </sidenav>
+    <main>
+        <h1><a style="color:rgb(14 116 144);" href="std.html">std</a>::<a style="color:rgb(14 116 144);" href="std/__winter_wonderland__.html">__winter_wonderland__</a>;</h1><hr/><div class="doc"><br/><h1 style="font-size: 25px;">Functions exported from std::__winter_wonderland__</h1><br/><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/__winter_wonderland__/poem.html><h1 style="color:rgb(14 116 144);margin-right: 10px;font-weight: normal;">poem</h1></a><span> Prints the Snowball Poem to the console.</span></div></div>
+    </main>
+</body>
+</html>
diff --git a/std/__winter_wonderland__/p-var.html b/std/__winter_wonderland__/p-var.html
@@ -0,0 +1,34 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+    <title>std::__winter_wonderland__::p</title>
+    <link rel="stylesheet" href="https://snowball-lang.github.io/autodoc-styles/styles.css">
+
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/atom-one-light.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/2.1.0/showdown.min.js" integrity="sha512-LhccdVNGe2QMEfI3x4DVV3ckMRe36TfydKss6mJpdHjNFiV07dFpS2xzeZedptKZrwxfICJpez09iNioiSZ3hA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://snowball-lang.github.io/autodoc-styles/md2html.js"></script>
+
+    <script src="https://snowball-lang.github.io/autodoc-styles/highlight.min.js"></script>
+
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Poppins:wght@400;500;600;700&display=swap" rel="stylesheet">
+
+    <base href="/snowball/">
+</head>
+<body>
+    <sidenav>
+        <h1 style="display: flex; align-items: center;">
+            std::__winter_wonderland__ <span class="tag">version 1.0.0</span>
+        </h1>
+        <hr />
+        <a href="std/__winter_wonderland__.html">&lt; Go Back</a> 
+    </sidenav>
+    <main>
+        <h1><a style="color:rgb(14 116 144);" href="std.html">std</a>::<a style="color:rgb(14 116 144);" href="std/__winter_wonderland__.html">__winter_wonderland__</a>::<a style="color:rgb(14 116 144);" href="std/__winter_wonderland__/p-var.html">p</a>;</h1><hr/><div><pre><code class="language-snowball">const p: i32 = ...</code></pre></div><br><div class="doc"><br/><br/></div>
+    </main>
+</body>
+</html>
diff --git a/std/__winter_wonderland__/poem.html b/std/__winter_wonderland__/poem.html
@@ -0,0 +1,34 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+    <title>std::__winter_wonderland__::poem</title>
+    <link rel="stylesheet" href="https://snowball-lang.github.io/autodoc-styles/styles.css">
+
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/atom-one-light.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/2.1.0/showdown.min.js" integrity="sha512-LhccdVNGe2QMEfI3x4DVV3ckMRe36TfydKss6mJpdHjNFiV07dFpS2xzeZedptKZrwxfICJpez09iNioiSZ3hA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://snowball-lang.github.io/autodoc-styles/md2html.js"></script>
+
+    <script src="https://snowball-lang.github.io/autodoc-styles/highlight.min.js"></script>
+
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Poppins:wght@400;500;600;700&display=swap" rel="stylesheet">
+
+    <base href="/snowball/">
+</head>
+<body>
+    <sidenav>
+        <h1 style="display: flex; align-items: center;">
+            std::__winter_wonderland__ <span class="tag">version 1.0.0</span>
+        </h1>
+        <hr />
+        <a href="std/__winter_wonderland__.html">&lt; Go Back</a> 
+    </sidenav>
+    <main>
+        <h1><a style="color:rgb(14 116 144);" href="std.html">std</a>::<a style="color:rgb(14 116 144);" href="std/__winter_wonderland__.html">__winter_wonderland__</a>::<a style="color:rgb(14 116 144);" href="std/__winter_wonderland__/poem.html">poem</a>;</h1><hr/><div><pre><code class="language-snowball">public static func poem() i32 { ... }</code></pre></div><br><div class="doc"><h1 style="color:rgb(14 116 144);">Brief Description for <quote>poem</quote></h1><p><br/>Prints the Snowball Poem to the console.</p><p><br/> The Snowball Poem is a short poem that describes the key features of the Snowball programming language,<br/> such as speed, security, object-orientation, and simplicity. This function simply prints the poem to<br/> the console using the standard output stream.<br/> <br/> ```<br/> In the land of Snowball, where the code is king,<br/> A language of speed and security we bring.<br/> Object-oriented, it makes programming fun,<br/> With a high-level view that's second to none.<br/> <br/> Simplicity is key, complexity we shun,<br/> Writing code is now an easy-run.<br/> The power of Snowball, it's easy to see,<br/> A language for all, just try it and you'll agree.<br/> <br/> Fast and secure, Snowball stands tall,<br/> With low-level speed that's the envy of all.<br/> So let your code run and your dreams take flight,<br/> In the land of Snowball, where everything's right.<br/> ```<br/> </p><hr/><h1 style="color:rgb(14 116 144);">@return</h1><p>i32 - It just exists but we return an integer anyway in order to store it in a constant.</p><br/><br/></div>
+    </main>
+</body>
+</html>
diff --git a/std/asserts.html b/std/asserts.html
@@ -0,0 +1,34 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+    <title>std::asserts</title>
+    <link rel="stylesheet" href="https://snowball-lang.github.io/autodoc-styles/styles.css">
+
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/atom-one-light.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/2.1.0/showdown.min.js" integrity="sha512-LhccdVNGe2QMEfI3x4DVV3ckMRe36TfydKss6mJpdHjNFiV07dFpS2xzeZedptKZrwxfICJpez09iNioiSZ3hA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://snowball-lang.github.io/autodoc-styles/md2html.js"></script>
+
+    <script src="https://snowball-lang.github.io/autodoc-styles/highlight.min.js"></script>
+
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Poppins:wght@400;500;600;700&display=swap" rel="stylesheet">
+
+    <base href="/snowball/">
+</head>
+<body>
+    <sidenav>
+        <h1 style="display: flex; align-items: center;">
+            std::asserts <span class="tag">version 1.0.0</span>
+        </h1>
+        <hr />
+        <a href="std/asserts.html">&lt; Go Back</a> 
+    </sidenav>
+    <main>
+        <h1><a style="color:rgb(14 116 144);" href="std.html">std</a>::<a style="color:rgb(14 116 144);" href="std/asserts.html">asserts</a>;</h1><hr/><div class="doc"><br/><h1 style="font-size: 25px;">Types exported from std::asserts</h1><br/><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/asserts/AssertionError.html><h1 style="color:rgb(45 212 191);margin-right: 10px;font-weight: normal;">AssertionError</h1></a><span> A class representing an assertion error.</span></div><br/><h1 style="font-size: 25px;">Macros exported from std::asserts</h1><br/><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/asserts/assert-macro.html><h1 style="color:#2bab63;margin-right: 10px;font-weight: normal;">assert</h1></a><span> Asserts a condition.</span></div><div style="display: grid; grid-template-columns: 1fr 1fr 1fr;"><a href=std/asserts/assert_eq-macro.html><h1 style="color:#2bab63;margin-right: 10px;font-weight: normal;">assert_eq</h1></a><span> Asserts that two values are equal.</span></div></div>
+    </main>
+</body>
+</html>
diff --git a/std/asserts/AssertionError.html b/std/asserts/AssertionError.html
@@ -0,0 +1,35 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+    <title>std::asserts::AssertionError</title>
+    <link rel="stylesheet" href="https://snowball-lang.github.io/autodoc-styles/styles.css">
+
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/atom-one-light.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/2.1.0/showdown.min.js" integrity="sha512-LhccdVNGe2QMEfI3x4DVV3ckMRe36TfydKss6mJpdHjNFiV07dFpS2xzeZedptKZrwxfICJpez09iNioiSZ3hA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://snowball-lang.github.io/autodoc-styles/md2html.js"></script>
+
+    <script src="https://snowball-lang.github.io/autodoc-styles/highlight.min.js"></script>
+
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Poppins:wght@400;500;600;700&display=swap" rel="stylesheet">
+
+    <base href="/snowball/">
+</head>
+<body>
+    <sidenav>
+        <h1 style="display: flex; align-items: center;">
+            std::asserts <span class="tag">version 1.0.0</span>
+        </h1>
+        <hr />
+        <a href="std/asserts.html">&lt; Go Back</a> 
+    </sidenav>
+    <main>
+        <h1><a style="color:rgb(14 116 144);" href="std.html">std</a>::<a style="color:rgb(14 116 144);" href="std/asserts.html">asserts</a>::<a style="color:rgb(14 116 144);" href="std/asserts/AssertionError.html">AssertionError</a>;</h1><hr/><div><pre><code class="language-snowball">public class AssertionError
+    extends Exception {};</code></pre></div><br><div class="doc"><h1 style="color:rgb(14 116 144);">Brief Description for <quote>AssertionError</quote></h1><p><br/>A class representing an assertion error.</p><p><br/> The `AssertionError` class is used to represent errors that occur when an assertion fails.<br/> It provides various operations and functionalities for working with assertion errors. This class<br/> inherits from the Exception class, making it suitable for use with exception handling mechanisms.<br/> You can use this class to capture and handle assertion failures in your code.<br/> </p></div>
+    </main>
+</body>
+</html>
diff --git a/std/asserts/assert-macro.html b/std/asserts/assert-macro.html
@@ -0,0 +1,36 @@
+
+<!DOCTYPE html>
+<html>
+<head>
+    <title>std::asserts::assert</title>
+    <link rel="stylesheet" href="https://snowball-lang.github.io/autodoc-styles/styles.css">
+
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/atom-one-light.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/2.1.0/showdown.min.js" integrity="sha512-LhccdVNGe2QMEfI3x4DVV3ckMRe36TfydKss6mJpdHjNFiV07dFpS2xzeZedptKZrwxfICJpez09iNioiSZ3hA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://snowball-lang.github.io/autodoc-styles/md2html.js"></script>
+
+    <script src="https://snowball-lang.github.io/autodoc-styles/highlight.min.js"></script>
+
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Poppins:wght@400;500;600;700&display=swap" rel="stylesheet">
+
+    <base href="/snowball/">
+</head>
+<body>
+    <sidenav>
+        <h1 style="display: flex; align-items: center;">
+            std::asserts <span class="tag">version 1.0.0</span>
+        </h1>
+        <hr />
+        <a href="std/asserts.html">&lt; Go Back</a> 
+    </sidenav>
+    <main>
+        <h1><a style="color:rgb(14 116 144);" href="std.html">std</a>::<a style="color:rgb(14 116 144);" href="std/asserts.html">asserts</a>::<a style="color:rgb(14 116 144);" href="std/asserts/assert-macro.html">assert</a>;</h1><hr/><div><pre><code class="language-snowball">macro assert(condition: expr, message: const[str] = ...) {
+    ...
+}</code></pre></div><br><div class="doc"><h1 style="color:rgb(14 116 144);">Brief Description for <quote>assert</quote></h1><p><br/>Asserts a condition.</p><p><br/> The `assert` macro is used to check whether a given condition is true. If the condition<br/> evaluates to false, an `AssertionError` exception is thrown, allowing you to capture<br/> and handle the assertion failure. This macro is a fundamental tool for validating<br/> assumptions and ensuring the correctness of your code.<br/> and is used to provide additional context when the assertion fails.<br/> Example Usage:<br/> ```c<br/> assert!(x &gt; 0, "x must be greater than 0");<br/> ```<br/> </p><br/><br/></div>
+    </main>
+</body>
+</html>