ludic/fs-read_text.html
2026-09-17 22:10:03 +00:00

35 lines
No EOL
1.9 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Fs.read_text — Ludic</title>
<meta name="description" content="Read a whole file as a string.">
<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="docs.css">
</head>
<body>
<header class="nav"><div class="wrap nav-in"><a class="brand" href="index.html"><span class="logo">L</span> Ludic</a><button class="nav-toggle" aria-label="Toggle menu" aria-expanded="false">☰</button><nav class="nav-links"><a href="index.html">Home</a><a href="api.html">API Reference</a><a class="nav-cta" href="https://git.workshopsoft.io/workshopsoft/ludic">Source ↗</a></nav></div></header>
<main class="wrap item">
<div class="crumbs"><a href="api.html">API Reference</a> <span>›</span> <a href="ns-fs.html">Fs</a> <span>›</span> <span class="here">Fs.read_text</span></div>
<div class="item-head">
<span class="kind-badge kind-method">method</span>
<h1 id="top">Fs.read_text</h1>
</div>
<code class="sig">Fs.read_text(p) -&gt; string</code>
<div class="desc"><p>Reads an entire file into a string (UTF-8 text), or returns <code>null</code> when it cannot be opened — check for <code>null</code> rather than assuming success. For a missing or unreadable save, fall back to a fresh default.</p></div>
<div class="params"><h2>Parameters</h2><div class="param" id="param-p"><code class="pname">p</code><span class="pdesc">the path to read</span></div></div>
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program ReadText {
entry {
if Fs.exists("saves/slot1.json") {
let text = Fs.read_text("saves/slot1.json")
print(len(text))
}
}
}</pre></div>
<a class="back" href="api.html">← All symbols</a>
</main>
<script src="ludic-highlight.js"></script>
<script>Ludic.highlightAll(); Ludic.installCards(); Ludic.flashTarget();</script>
</body></html>