std.fs.writeText

writeText(path: string | Path, text: string) -> Result<(), string>

모듈: std.fs →
수신자: 해당 없음
최소 인자 수: 2
최대 인자 수: 2

Declaration and parameters

사용 조건

기본 포함 · 미정

Import std.fs in language mode 5.21.

The current compiler selects std/fs.tpz for this language mode. Availability in other released editions and inclusion in each installed distribution are Pending.

수신자

해당 없음

매개변수 제약

추가 계약은 미정입니다.

Each function accepts a string path or a Path. Strings use the host path syntax. A Path supplies its normalized relative text. Relative paths use the working directory in an ordinary installed CLI invocation. A package host applies its configured filesystem base and capability policy.

Path and payload arguments are evaluated once in source order before the operation starts. The operation acquires and releases its own resources before returning. It does not change a separately opened File cursor.

Empty paths and paths containing NUL return Err containing a string. Missing read targets, incorrect path kinds, permission denial, package capability denial, and host failures use the same error channel. Errors are values. They do not terminate the program unless the caller chooses to propagate or assert them.

An error string identifies the public operation and the supplied path. It also describes the failure condition. Platform wording, operating system error numbers, and localized explanations are not stable API values.

readText returns the entire regular file as text. UTF-8 validity and text preservation follow UTF-8 decoding. Empty files return an empty string. Invalid UTF-8 returns Err without a decoded text value.

readBytes returns every byte in order, including zero bytes and bytes that are not valid UTF-8. Empty files return empty Bytes. Reading does not create or modify the file.

writeText encodes its string as UTF-8. writeBytes writes the supplied bytes unchanged. Both create a missing regular file or replace the full contents of an existing regular file. An empty payload creates or truncates the file to zero bytes. No newline or byte order mark is added.

Writes do not create missing parent directories. They follow the host permission and creation policy. Replacing a file with shorter content removes its previous suffix. Success returns Ok(()) after all payload bytes have been accepted.

A write failure may occur after creation, truncation, or a prefix write. Err does not promise rollback, atomic replacement, or persistence across a system crash. Earlier argument effects remain visible.

list returns immediate children sorted by their exact names in ascending Unicode scalar order. It does not return dot or parent pseudoentries, traverse child directories, normalize Unicode names, or fold case. The name field contains the child name without the parent path.

Each entry kind is exactly file, directory, symlink, or other. Classification uses the entry itself and does not follow a symbolic link. For a regular file, sizeBytes is Some of its byte length when that length fits in int. Other kinds and an unrepresentable size use None().

A name that cannot be represented as Unicode, a failure while reading an entry, or a failure obtaining its metadata returns Err for the whole list. No partial array is returned. Separate operations do not provide a filesystem snapshot, so other processes may change a path between calls.

Host access follows symbolic links where the operation addresses their target, subject to host capability checks. A normalized Path is not an authorization token. Use File when operations must retain one open resource and cursor, and std.fs when the operation concerns complete contents or directory entries.

결과

추가 계약은 미정입니다.

The declared result type is Result<(), string>.

효과

미정

실패

미정

Result and effects

링크

Create or replace a complete regular file with the UTF-8 encoding of the supplied text.

링크

std.fs →

Read and replace whole files and list directories

링크

규칙topaz.stdlib.contract.filesystem.rule

Read and replace whole files and list directories

readBytes returns every byte in order, including zero bytes and bytes that are not valid UTF-8. Empty files return empty Bytes. Reading does not create or modify the file.

이유

Exact bytes and strict text decoding keep data conversion explicit. Whole file replacement has a clear effect, and Result makes permission and host failures recoverable. Sorting names makes directory traversal repeatable for a fixed directory state without assuming a host enumeration order.

예제 Replace and create text files with exact content →Preserve a byte order mark and physical line endings →Preserve raw bytes and reject invalid UTF-8 text →List immediate entries in exact name order →Return recoverable errors for the wrong path kind →Evaluate payloads before replacing a file →Identify the operation and path in a readText error →Identify the operation and path in a readBytes error →Identify the operation and path in a writeText error →Identify the operation and path in a writeBytes error →Identify the operation and path in a list error →

Replace and create text files with exact content

링크

run · running · 검증 · 미실행

main.tpzReplace and create text files with exact content플레이그라운드 열기 →

import std.fs
import std.path { Path }
import std.test
import std.io
let path = test.assertOk(Path.from("chapter.txt"))
test.assertOk(fs.writeText(path, "short\n"))
io.writeLine(test.assertOk(fs.readText("chapter.txt")))
test.assertOk(fs.writeText("created.txt", "한글"))
io.writeLine(test.assertOk(fs.readText("created.txt")))
test.assertOk(fs.writeText("created.txt", ""))
let text = test.assertOk(fs.readText("created.txt"))
let empty = text == ""
io.writeLine("empty {empty}")

기대 출력종료 코드 0

short

한글
empty true

$ topaz run main.tpz · 대상 제품 5.21.3

chapter.txtReplace and create text files with exact content플레이그라운드 열기 →

a much longer old value

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

short
한글
empty true

이 예제는 아직 실행하지 않았습니다.

Preserve a byte order mark and physical line endings

링크

run · running · 검증 · 미실행

main.tpzPreserve a byte order mark and physical line endings플레이그라운드 열기 →

import std.fs
import std.test
import std.io
io.writeLine(test.assertOk(fs.readText("source.txt")))

기대 출력종료 코드 0

alpha
한글

$ topaz run main.tpz · 대상 제품 5.21.3

source.txtPreserve a byte order mark and physical line endings플레이그라운드 열기 →

alpha
한글

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

alpha
한글

이 예제는 아직 실행하지 않았습니다.

Preserve raw bytes and reject invalid UTF-8 text

링크

run · running · 검증 · 미실행

main.tpzPreserve raw bytes and reject invalid UTF-8 text플레이그라운드 열기 →

import std.fs
import std.bytes { Bytes }
import std.test
import std.io
let bytes = test.assertOk(Bytes.fromArray([0, 65, 255]))
test.assertOk(fs.writeBytes("data.bin", bytes))
io.writeLine(test.assertOk(fs.readBytes("data.bin")).toHex())
test.assertErr(fs.readText("data.bin"))
io.writeLine("invalid text rejected")
test.assertOk(fs.writeBytes("data.bin", Bytes.empty()))
io.writeLine(test.assertOk(fs.readBytes("data.bin")).toHex())

기대 출력종료 코드 0

0041ff
invalid text rejected

$ topaz run main.tpz · 대상 제품 5.21.3

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

0041ff
invalid text rejected

이 예제는 아직 실행하지 않았습니다.

List immediate entries in exact name order

링크

run · running · 검증 · 미실행

main.tpzList immediate entries in exact name order플레이그라운드 열기 →

import std.fs
import std.test
import std.io
let entries = test.assertOk(fs.list("entries"))
for entry in (entries) {
let size = match (entry.sizeBytes) {
case Some(value) => "{value}"
case None() => "none"
}
io.writeLine("{entry.name} {entry.kind} {size}")
}

기대 출력종료 코드 0

a.txt file 1
nested directory none
z.txt file 2

$ topaz run main.tpz · 대상 제품 5.21.3

entries/z.txtList immediate entries in exact name order플레이그라운드 열기 →

zz

entries/a.txtList immediate entries in exact name order플레이그라운드 열기 →

entries/nested/inside.txtList immediate entries in exact name order플레이그라운드 열기 →

inside

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

a.txt file 1
nested directory none
z.txt file 2

이 예제는 아직 실행하지 않았습니다.

Return recoverable errors for the wrong path kind

링크

run · running · 검증 · 미실행

main.tpzReturn recoverable errors for the wrong path kind플레이그라운드 열기 →

import std.fs
import std.test
import std.io
test.assertErr(fs.readText("directory"))
test.assertErr(fs.readBytes("directory"))
test.assertErr(fs.writeText("directory", "text"))
test.assertErr(fs.list("plain.txt"))
io.writeLine("wrong kinds rejected")

기대 출력종료 코드 0

wrong kinds rejected

$ topaz run main.tpz · 대상 제품 5.21.3

directory/inside.txtReturn recoverable errors for the wrong path kind플레이그라운드 열기 →

inside

plain.txtReturn recoverable errors for the wrong path kind플레이그라운드 열기 →

plain

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

wrong kinds rejected

이 예제는 아직 실행하지 않았습니다.

Evaluate payloads before replacing a file

링크

run · running · 검증 · 미실행

main.tpzEvaluate payloads before replacing a file플레이그라운드 열기 →

import std.fs
import std.test
import std.io
function target() -> string {
io.writeLine("path")
return "source.txt"
}
function payload() -> string {
io.writeLine("text")
io.writeLine(test.assertOk(fs.readText("source.txt")))
return "new"
}
test.assertOk(fs.writeText(target(), payload()))
io.writeLine(test.assertOk(fs.readText("source.txt")))

기대 출력종료 코드 0

path
text
old
new

$ topaz run main.tpz · 대상 제품 5.21.3

source.txtEvaluate payloads before replacing a file플레이그라운드 열기 →

old

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

path
text
old
new

이 예제는 아직 실행하지 않았습니다.

Identify the operation and path in a readText error

링크

run · running · 검증 · 미실행

main.tpzIdentify the operation and path in a readText error플레이그라운드 열기 →

import std.fs
import std.bytes { Bytes }
import std.test
import std.io
let error = test.assertErr(fs.readText("missing/item.txt"))
let operation = error.contains("readText")
let path = error.contains("missing/item.txt")
io.writeLine("{operation} {path}")

기대 출력종료 코드 0

true true

$ topaz run main.tpz · 대상 제품 5.21.3

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

true true

이 예제는 아직 실행하지 않았습니다.

Identify the operation and path in a readBytes error

링크

run · running · 검증 · 미실행

main.tpzIdentify the operation and path in a readBytes error플레이그라운드 열기 →

import std.fs
import std.bytes { Bytes }
import std.test
import std.io
let error = test.assertErr(fs.readBytes("missing/item.txt"))
let operation = error.contains("readBytes")
let path = error.contains("missing/item.txt")
io.writeLine("{operation} {path}")

기대 출력종료 코드 0

true true

$ topaz run main.tpz · 대상 제품 5.21.3

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

true true

이 예제는 아직 실행하지 않았습니다.

Identify the operation and path in a writeText error

링크

run · running · 검증 · 미실행

main.tpzIdentify the operation and path in a writeText error플레이그라운드 열기 →

import std.fs
import std.bytes { Bytes }
import std.test
import std.io
let error = test.assertErr(fs.writeText("missing/item.txt", "text"))
let operation = error.contains("writeText")
let path = error.contains("missing/item.txt")
io.writeLine("{operation} {path}")

기대 출력종료 코드 0

true true

$ topaz run main.tpz · 대상 제품 5.21.3

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

true true

이 예제는 아직 실행하지 않았습니다.

Identify the operation and path in a writeBytes error

링크

run · running · 검증 · 미실행

main.tpzIdentify the operation and path in a writeBytes error플레이그라운드 열기 →

import std.fs
import std.bytes { Bytes }
import std.test
import std.io
let error = test.assertErr(fs.writeBytes("missing/item.txt", Bytes.empty()))
let operation = error.contains("writeBytes")
let path = error.contains("missing/item.txt")
io.writeLine("{operation} {path}")

기대 출력종료 코드 0

true true

$ topaz run main.tpz · 대상 제품 5.21.3

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

true true

이 예제는 아직 실행하지 않았습니다.

Identify the operation and path in a list error

링크

run · running · 검증 · 미실행

main.tpzIdentify the operation and path in a list error플레이그라운드 열기 →

import std.fs
import std.bytes { Bytes }
import std.test
import std.io
let error = test.assertErr(fs.list("missing/item.txt"))
let operation = error.contains("list")
let path = error.contains("missing/item.txt")
io.writeLine("{operation} {path}")

기대 출력종료 코드 0

true true

$ topaz run main.tpz · 대상 제품 5.21.3

기대 결과

실행을 마칩니다. 종료 코드 0.

표준 오류 출력 없음.

기대 표준 출력

true true

이 예제는 아직 실행하지 않았습니다.

문서 검색

std.fs.writeText

Declaration and parameters

사용 조건

수신자

매개변수 제약

결과

효과

실패

Result and effects

Read and replace whole files and list directories

Read and replace whole files and list directories

이유

Replace and create text files with exact content

기대 결과

Preserve a byte order mark and physical line endings

기대 결과

Preserve raw bytes and reject invalid UTF-8 text

기대 결과

List immediate entries in exact name order

기대 결과

Return recoverable errors for the wrong path kind

기대 결과

Evaluate payloads before replacing a file

기대 결과

Identify the operation and path in a readText error

기대 결과

Identify the operation and path in a readBytes error

기대 결과

Identify the operation and path in a writeText error

기대 결과

Identify the operation and path in a writeBytes error

기대 결과

Identify the operation and path in a list error

기대 결과

메뉴

Declaration and parameters

사용 조건

수신자

매개변수 제약

결과

효과

실패

Result and effects

Related entries

Read and replace whole files and list directories

Read and replace whole files and list directories

이유

Replace and create text files with exact content

기대 결과

Preserve a byte order mark and physical line endings

기대 결과

Preserve raw bytes and reject invalid UTF-8 text

기대 결과

List immediate entries in exact name order

기대 결과

Return recoverable errors for the wrong path kind

기대 결과

Evaluate payloads before replacing a file

기대 결과

Identify the operation and path in a readText error

기대 결과

Identify the operation and path in a readBytes error

기대 결과

Identify the operation and path in a writeText error

기대 결과

Identify the operation and path in a writeBytes error

기대 결과

Identify the operation and path in a list error

기대 결과