XU XUv0.8.8
EN

API

#io/fs

import: #io/fs

counts: 5 函数, 0 方法, 1 类型, 0 常量, 2 方法集

目录树视图。实现钉死 os.DirFS；包级函数吃 &os.DirFS。valid_path 检查未加根的斜杠路径。

struct@ FS

XuAPI
struct@ FS {
    fn open(string) os.File
}

用途

方法集约束 `FS`。实现类型须提供下列方法。不是接口值。

参数

open fn open(string) os.File
`FS` 上的方法：打开。

(FS) open

XuAPI
fn open(string) os.File

用途

`FS` 上的方法：打开。

参数

self Self
接收者 Self（值接收者）
string string
string（string）

返回

os.File — 该类型的值

struct@ File

XuAPI
struct@ File {
    fn read(int) string
    fn close() int
}

用途

方法集约束 `File`。实现类型须提供下列方法。不是接口值。

参数

read fn read(int) string
`File` 上的方法：读出最多 max 字节。
close fn close() int
`File` 上的方法：关闭资源。

(File) read

XuAPI
fn read(int) string

用途

`File` 上的方法：读出最多 max 字节。

参数

self Self
接收者 Self（值接收者）
int int
int（int）

返回

string — 结果字符串

(File) close

XuAPI
fn close() int

用途

`File` 上的方法：关闭资源。

参数

self Self
接收者 Self（值接收者）

返回

int — 该类型的值

struct DirEntry

XuAPI
pub struct DirEntry {
    pub name string
    pub is_dir bool
}

用途

公开结构体 `DirEntry`。

参数

name string
名字
is_dir bool
字段（bool）

valid_path

XuAPI
pub fn valid_path(name &string) bool

用途

检查路径是否为未加根、斜杠分隔的合法名；仅允许 “.” 作为根。

参数

name &string
名字（借用，调用方仍持有；类型 &string）

返回

bool — 是否成立

read_file

XuAPI
pub fn read_file(fsys &os.DirFS, name string) string

用途

读文件。失败时 throw。

参数

fsys &os.DirFS
fsys（借用，调用方仍持有；类型 &os.DirFS）
name string
名字（string）

返回

string — 结果字符串

read_dir

XuAPI
pub fn read_dir(fsys &os.DirFS, name string) []DirEntry

用途

列目录。失败时 throw。

参数

fsys &os.DirFS
fsys（借用，调用方仍持有；类型 &os.DirFS）
name string
名字（string）

返回

[]DirEntry — 切片结果

stat

XuAPI
pub fn stat(fsys &os.DirFS, name string) FileInfo

用途

读取元信息。失败时 throw。

参数

fsys &os.DirFS
fsys（借用，调用方仍持有；类型 &os.DirFS）
name string
名字（string）

返回

FileInfo — 该类型的值

sub

XuAPI
pub fn sub(fsys &os.DirFS, dir string) os.DirFS

用途

相减。失败时 throw。

参数

fsys &os.DirFS
fsys（借用，调用方仍持有；类型 &os.DirFS）
dir string
目录（string）

返回

os.DirFS — 该类型的值