retoor
819bbd5091
Add three new example scripts demonstrating the fswatch, sysinfo, and udp modules with file watching, system metrics, and UDP echo server/client patterns. Reorder the manual API sidebar navigation to list modules alphabetically, removing deprecated entries like websocket, tls, net, json, regex, jinja, os, signal, subprocess, sqlite, and timer while adding argparse, dataset, fswatch, and html.
405 lines
18 KiB
HTML
405 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<!-- retoor <retoor@molodetz.nl> -->
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>io - Wren-CLI Manual</title>
|
|
<link rel="stylesheet" href="../css/style.css">
|
|
</head>
|
|
<body>
|
|
<button class="mobile-menu-toggle">Menu</button>
|
|
<div class="container">
|
|
<aside class="sidebar">
|
|
<div class="sidebar-header">
|
|
<h1><a href="../index.html">Wren-CLI</a></h1>
|
|
<div class="version">v0.4.0</div>
|
|
</div>
|
|
<nav class="sidebar-nav">
|
|
<div class="section">
|
|
<span class="section-title">Getting Started</span>
|
|
<ul>
|
|
<li><a href="../getting-started/index.html">Overview</a></li>
|
|
<li><a href="../getting-started/installation.html">Installation</a></li>
|
|
<li><a href="../getting-started/first-script.html">First Script</a></li>
|
|
<li><a href="../getting-started/repl.html">Using the REPL</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section">
|
|
<span class="section-title">Language</span>
|
|
<ul>
|
|
<li><a href="../language/index.html">Syntax Overview</a></li>
|
|
<li><a href="../language/classes.html">Classes</a></li>
|
|
<li><a href="../language/methods.html">Methods</a></li>
|
|
<li><a href="../language/control-flow.html">Control Flow</a></li>
|
|
<li><a href="../language/fibers.html">Fibers</a></li>
|
|
<li><a href="../language/modules.html">Modules</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section">
|
|
<span class="section-title">API Reference</span>
|
|
<ul>
|
|
<li><a href="index.html">Overview</a></li>
|
|
<li><a href="string.html">String</a></li>
|
|
<li><a href="number.html">Num</a></li>
|
|
<li><a href="argparse.html">argparse</a></li>
|
|
<li><a href="base64.html">base64</a></li>
|
|
<li><a href="crypto.html">crypto</a></li>
|
|
<li><a href="dataset.html">dataset</a></li>
|
|
<li><a href="datetime.html">datetime</a></li>
|
|
<li><a href="dns.html">dns</a></li>
|
|
<li><a href="env.html">env</a></li>
|
|
<li><a href="fswatch.html">fswatch</a></li>
|
|
<li><a href="html.html">html</a></li>
|
|
<li><a href="http.html">http</a></li>
|
|
<li><a href="io.html" class="active">io</a></li>
|
|
<li><a href="jinja.html">jinja</a></li>
|
|
<li><a href="json.html">json</a></li>
|
|
<li><a href="markdown.html">markdown</a></li>
|
|
<li><a href="math.html">math</a></li>
|
|
<li><a href="net.html">net</a></li>
|
|
<li><a href="os.html">os</a></li>
|
|
<li><a href="pathlib.html">pathlib</a></li>
|
|
<li><a href="regex.html">regex</a></li>
|
|
<li><a href="scheduler.html">scheduler</a></li>
|
|
<li><a href="signal.html">signal</a></li>
|
|
<li><a href="sqlite.html">sqlite</a></li>
|
|
<li><a href="subprocess.html">subprocess</a></li>
|
|
<li><a href="sysinfo.html">sysinfo</a></li>
|
|
<li><a href="tempfile.html">tempfile</a></li>
|
|
<li><a href="timer.html">timer</a></li>
|
|
<li><a href="tls.html">tls</a></li>
|
|
<li><a href="udp.html">udp</a></li>
|
|
<li><a href="uuid.html">uuid</a></li>
|
|
<li><a href="wdantic.html">wdantic</a></li>
|
|
<li><a href="web.html">web</a></li>
|
|
<li><a href="websocket.html">websocket</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section">
|
|
<span class="section-title">Tutorials</span>
|
|
<ul>
|
|
<li><a href="../tutorials/index.html">Tutorial List</a></li>
|
|
<li><a href="../tutorials/http-client.html">HTTP Client</a></li>
|
|
<li><a href="../tutorials/websocket-chat.html">WebSocket Chat</a></li>
|
|
<li><a href="../tutorials/database-app.html">Database App</a></li>
|
|
<li><a href="../tutorials/template-rendering.html">Templates</a></li>
|
|
<li><a href="../tutorials/cli-tool.html">CLI Tool</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section">
|
|
<span class="section-title">How-To Guides</span>
|
|
<ul>
|
|
<li><a href="../howto/index.html">How-To List</a></li>
|
|
<li><a href="../howto/http-requests.html">HTTP Requests</a></li>
|
|
<li><a href="../howto/json-parsing.html">JSON Parsing</a></li>
|
|
<li><a href="../howto/regex-patterns.html">Regex Patterns</a></li>
|
|
<li><a href="../howto/file-operations.html">File Operations</a></li>
|
|
<li><a href="../howto/async-operations.html">Async Operations</a></li>
|
|
<li><a href="../howto/error-handling.html">Error Handling</a></li>
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
</aside>
|
|
<main class="content">
|
|
<nav class="breadcrumb">
|
|
<a href="../index.html">Home</a>
|
|
<span class="separator">/</span>
|
|
<a href="index.html">API Reference</a>
|
|
<span class="separator">/</span>
|
|
<span>io</span>
|
|
</nav>
|
|
|
|
<article>
|
|
<h1>io</h1>
|
|
|
|
<p>The <code>io</code> module provides file and directory operations, as well as stdin/stdout handling.</p>
|
|
|
|
<pre><code>import "io" for File, Directory, Stdin, Stdout, Stat</code></pre>
|
|
|
|
<h2>File Class</h2>
|
|
|
|
<div class="class-header">
|
|
<h3>File</h3>
|
|
<p>File operations</p>
|
|
</div>
|
|
|
|
<h3>Static Methods</h3>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">File.read</span>(<span class="param">path</span>) → <span class="type">String</span>
|
|
</div>
|
|
<p>Reads the entire contents of a file.</p>
|
|
<pre><code>var content = File.read("config.txt")
|
|
System.print(content)</code></pre>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">File.write</span>(<span class="param">path</span>, <span class="param">content</span>)
|
|
</div>
|
|
<p>Writes content to a file (creates or overwrites).</p>
|
|
<pre><code>File.write("output.txt", "Hello, World!")</code></pre>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">File.exists</span>(<span class="param">path</span>) → <span class="type">Bool</span>
|
|
</div>
|
|
<p>Returns true if the file exists.</p>
|
|
<pre><code>if (File.exists("config.txt")) {
|
|
System.print("Config found")
|
|
}</code></pre>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">File.delete</span>(<span class="param">path</span>)
|
|
</div>
|
|
<p>Deletes a file.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">File.size</span>(<span class="param">path</span>) → <span class="type">Num</span>
|
|
</div>
|
|
<p>Returns the size of a file in bytes.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">File.copy</span>(<span class="param">source</span>, <span class="param">dest</span>)
|
|
</div>
|
|
<p>Copies a file from source to destination.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">File.rename</span>(<span class="param">oldPath</span>, <span class="param">newPath</span>)
|
|
</div>
|
|
<p>Renames a file within the same filesystem.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">File.move</span>(<span class="param">source</span>, <span class="param">dest</span>)
|
|
</div>
|
|
<p>Moves a file from source to destination. Uses libuv's async rename operation.</p>
|
|
<pre><code>File.move("old/location/file.txt", "new/location/file.txt")</code></pre>
|
|
|
|
<h2>Directory Class</h2>
|
|
|
|
<div class="class-header">
|
|
<h3>Directory</h3>
|
|
<p>Directory operations</p>
|
|
</div>
|
|
|
|
<h3>Static Methods</h3>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">Directory.list</span>(<span class="param">path</span>) → <span class="type">List</span>
|
|
</div>
|
|
<p>Lists the contents of a directory.</p>
|
|
<pre><code>var files = Directory.list(".")
|
|
for (file in files) {
|
|
System.print(file)
|
|
}</code></pre>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">Directory.exists</span>(<span class="param">path</span>) → <span class="type">Bool</span>
|
|
</div>
|
|
<p>Returns true if the directory exists.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">Directory.create</span>(<span class="param">path</span>)
|
|
</div>
|
|
<p>Creates a directory.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">Directory.delete</span>(<span class="param">path</span>)
|
|
</div>
|
|
<p>Deletes an empty directory.</p>
|
|
|
|
<h2>Stdin Class</h2>
|
|
|
|
<div class="class-header">
|
|
<h3>Stdin</h3>
|
|
<p>Standard input</p>
|
|
</div>
|
|
|
|
<h3>Static Methods</h3>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">Stdin.readLine</span>() → <span class="type">String</span>
|
|
</div>
|
|
<p>Reads a line from standard input.</p>
|
|
<pre><code>System.write("Enter your name: ")
|
|
var name = Stdin.readLine()
|
|
System.print("Hello, %(name)!")</code></pre>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">Stdin.read</span>() → <span class="type">String</span>
|
|
</div>
|
|
<p>Reads all available data from stdin.</p>
|
|
|
|
<h2>Stdout Class</h2>
|
|
|
|
<div class="class-header">
|
|
<h3>Stdout</h3>
|
|
<p>Standard output</p>
|
|
</div>
|
|
|
|
<h3>Static Methods</h3>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">Stdout.flush</span>()
|
|
</div>
|
|
<p>Flushes the stdout buffer.</p>
|
|
|
|
<h2>Stat Class</h2>
|
|
|
|
<div class="class-header">
|
|
<h3>Stat</h3>
|
|
<p>File metadata and statistics</p>
|
|
</div>
|
|
|
|
<h3>Static Methods</h3>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">Stat.path</span>(<span class="param">path</span>) → <span class="type">Stat</span>
|
|
</div>
|
|
<p>Returns a Stat object for the specified path.</p>
|
|
<pre><code>var stat = Stat.path("/etc/hosts")
|
|
System.print("Size: %(stat.size) bytes")</code></pre>
|
|
|
|
<h3>Properties</h3>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">size</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The size of the file in bytes.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">isFile</span> → <span class="type">Bool</span>
|
|
</div>
|
|
<p>True if the path is a regular file.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">isDirectory</span> → <span class="type">Bool</span>
|
|
</div>
|
|
<p>True if the path is a directory.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">mtime</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The modification time as a Unix timestamp (seconds since epoch).</p>
|
|
<pre><code>var stat = Stat.path("file.txt")
|
|
System.print("Modified: %(stat.mtime)")</code></pre>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">atime</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The access time as a Unix timestamp.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">ctime</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The change time (inode change) as a Unix timestamp.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">mode</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The file permission mode.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">inode</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The inode number.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">device</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The device ID containing the file.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">linkCount</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The number of hard links to the file.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">user</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The user ID of the file owner.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">group</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The group ID of the file.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">blockSize</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The preferred block size for I/O operations.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-name">blockCount</span> → <span class="type">Num</span>
|
|
</div>
|
|
<p>The number of blocks allocated for the file.</p>
|
|
|
|
<h2>Examples</h2>
|
|
|
|
<h3>Reading and Writing Files</h3>
|
|
<pre><code>import "io" for File
|
|
|
|
var content = File.read("input.txt")
|
|
var processed = content.replace("old", "new")
|
|
File.write("output.txt", processed)</code></pre>
|
|
|
|
<h3>Working with JSON Files</h3>
|
|
<pre><code>import "io" for File
|
|
import "json" for Json
|
|
|
|
var config = Json.parse(File.read("config.json"))
|
|
config["updated"] = true
|
|
File.write("config.json", Json.stringify(config, 2))</code></pre>
|
|
|
|
<h3>Processing Directory Contents</h3>
|
|
<pre><code>import "io" for File, Directory
|
|
|
|
var files = Directory.list("./data")
|
|
for (file in files) {
|
|
if (file.endsWith(".txt")) {
|
|
var path = "./data/%(file)"
|
|
var size = File.size(path)
|
|
System.print("%(file): %(size) bytes")
|
|
}
|
|
}</code></pre>
|
|
|
|
<h3>Interactive Input</h3>
|
|
<pre><code>import "io" for Stdin
|
|
|
|
System.write("Username: ")
|
|
var username = Stdin.readLine()
|
|
|
|
System.write("Age: ")
|
|
var age = Num.fromString(Stdin.readLine())
|
|
|
|
System.print("Hello %(username), you are %(age) years old")</code></pre>
|
|
|
|
<h3>File Backup</h3>
|
|
<pre><code>import "io" for File
|
|
import "datetime" for DateTime
|
|
|
|
var backup = Fn.new { |path|
|
|
if (!File.exists(path)) return
|
|
|
|
var timestamp = DateTime.now().format("\%Y\%m\%d_\%H\%M\%S")
|
|
var backupPath = "%(path).%(timestamp).bak"
|
|
File.copy(path, backupPath)
|
|
System.print("Backed up to %(backupPath)")
|
|
}
|
|
|
|
backup.call("important.txt")</code></pre>
|
|
|
|
<div class="admonition note">
|
|
<div class="admonition-title">Note</div>
|
|
<p>File operations are synchronous but use libuv internally for async I/O. The fiber suspends during I/O operations.</p>
|
|
</div>
|
|
</article>
|
|
|
|
<footer class="page-footer">
|
|
<a href="timer.html" class="prev">timer</a>
|
|
<a href="pathlib.html" class="next">pathlib</a>
|
|
</footer>
|
|
</main>
|
|
</div>
|
|
<script src="../js/main.js"></script>
|
|
</body>
|
|
</html>
|