#io

struct@ Writer

struct@ Writer {
    fn write(&string) int
}

用途

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

参数

write fn write(&string) int

`Writer` 上的方法：写入数据，返回写入的字节数。

(Writer) write

fn write(&string) int

用途

`Writer` 上的方法：写入数据，返回写入的字节数。

参数

self Self

接收者 Self（值接收者）

string &string

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

返回

int — 写入的字节数

struct@ Reader

struct@ Reader {
    fn read_n(int) string
}

用途

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

参数

read_n fn read_n(int) string

`Reader` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

(Reader) read_n

fn read_n(int) string

用途

`Reader` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

参数

self Self

接收者 Self（值接收者）

int int

int（int）

返回

string — 结果字符串

struct Buffer

pub struct Buffer {
    pub data string
    pub off int
}

用途

公开结构体 `Buffer`。

参数

data string

数据

off int

偏移

struct Cursor

pub struct Cursor {
    pub data string
    pub off int
}

用途

公开结构体 `Cursor`。

参数

data string

数据

off int

偏移

buffer

pub fn buffer() Buffer

用途

缓冲。

参数

无

返回

Buffer — 该类型的值

buffer_from

pub fn buffer_from(s string) Buffer

用途

缓冲从。

参数

s string

源字符串（string）

返回

Buffer — 该类型的值

cursor

pub fn cursor(s string) Cursor

用途

游标。

参数

s string

源字符串（string）

返回

Cursor — 该类型的值

(&mut Cursor) reset

pub fn (c &mut Cursor) reset(s string)

用途

`&mut Cursor` 上的方法：清空内部状态，可再写入或读取。

参数

c &mut Cursor

接收者 &mut Cursor（可变借用）

s string

源字符串（string）

(&mut Buffer) reset

pub fn (b &mut Buffer) reset()

用途

`&mut Buffer` 上的方法：清空内部状态，可再写入或读取。

参数

b &mut Buffer

接收者 &mut Buffer（可变借用）

(&Buffer) len

pub fn (b &Buffer) len() int

用途

`&Buffer` 上的方法：返回长度。

参数

b &Buffer

接收者 &Buffer（借用）

返回

int — 该类型的值

(&Buffer) cap

pub fn (b &Buffer) cap() int

用途

`&Buffer` 上的方法：返回容量。

参数

b &Buffer

接收者 &Buffer（借用）

返回

int — 该类型的值

(&Cursor) size

pub fn (c &Cursor) size() int

用途

`&Cursor` 上的方法：返回尺寸。

参数

c &Cursor

接收者 &Cursor（借用）

返回

int — 该类型的值

(&mut Buffer) write

pub fn (b &mut Buffer) write(data &string) int

用途

`&mut Buffer` 上的方法：写入数据，返回写入的字节数。

参数

b &mut Buffer

接收者 &mut Buffer（可变借用）

data &string

数据（借用，调用方仍持有；类型 &string）

返回

int — 写入的字节数

(&mut Buffer) write_str

pub fn (b &mut Buffer) write_str(s string) int

用途

`&mut Buffer` 上的方法：写入字符串。

参数

b &mut Buffer

接收者 &mut Buffer（可变借用）

s string

源字符串（string）

返回

int — 该类型的值

(&mut Buffer) write_byte

pub fn (b &mut Buffer) write_byte(c int) int

用途

`&mut Buffer` 上的方法：写入一个字节。

参数

b &mut Buffer

接收者 &mut Buffer（可变借用）

c int

字节或字符码（int）

返回

int — 写入的字节数

(&mut Buffer) read_n

pub fn (b &mut Buffer) read_n(n int) string

用途

`&mut Buffer` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

参数

b &mut Buffer

接收者 &mut Buffer（可变借用）

n int

数量、长度或上限（int）

返回

string — 结果字符串

(&Buffer) bytes

pub fn (b &Buffer) bytes() string

用途

`&Buffer` 上的方法：返回已缓冲的字节串。

参数

b &Buffer

接收者 &Buffer（借用）

返回

string — 结果字符串

(&mut Cursor) read_n

pub fn (c &mut Cursor) read_n(n int) string

用途

`&mut Cursor` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

参数

c &mut Cursor

接收者 &mut Cursor（可变借用）

n int

数量、长度或上限（int）

返回

string — 结果字符串

copy

pub fn copy(dst Buffer, src Cursor) string

用途

拷贝。

参数

dst Buffer

目标（Buffer）

src Cursor

源数据（Cursor）

返回

string — 结果字符串

copy_to

pub fn copy_to(dst Buffer, src Cursor) Buffer

用途

拷贝到。

参数

dst Buffer

目标（Buffer）

src Cursor

源数据（Cursor）

返回

Buffer — 该类型的值

read_all

pub fn read_all(src Cursor) string

用途

读取all。

参数

src Cursor

源数据（Cursor）

返回

string — 结果字符串

const eof

pub const eof = "EOF"

用途

公开常量 `eof`。 值为 `"EOF"`

参数

无

(&Cursor) remaining

pub fn (c &Cursor) remaining() int

用途

在 `&Cursor` 上调用 `remaining`。

参数

c &Cursor

接收者 &Cursor（借用）

返回

int — 该类型的值

(&mut Cursor) seek

pub fn (c &mut Cursor) seek(offset int, whence int) int

用途

`&mut Cursor` 上的方法：按 whence 把读位置移到 offset。whence 0/1/2 分别为绝对、相对、从末尾。失败时 throw。

参数

c &mut Cursor

接收者 &mut Cursor（可变借用）

offset int

偏移（int）

whence int

定位基准：0 起点 / 1 当前 / 2 末尾（int）

返回

int — 该类型的值

(&Cursor) read_at

pub fn (c &Cursor) read_at(n int, off int) string

用途

`&Cursor` 上的方法：从偏移 off 起最多读 n 字节。失败时 throw。

参数

c &Cursor

接收者 &Cursor（借用）

n int

数量、长度或上限（int）

off int

偏移（int）

返回

string — 结果字符串

read_full

pub fn read_full(src Cursor, n int) string

用途

读取full。

参数

src Cursor

源数据（Cursor）

n int

数量、长度或上限（int）

返回

string — 结果字符串

read_at_least

pub fn read_at_least(src Cursor, min int, max int) string

用途

读取atleast。失败时 throw。

参数

src Cursor

源数据（Cursor）

min int

下限（int）

max int

上限（int）

返回

string — 结果字符串

copy_n

pub fn copy_n(dst Buffer, src Cursor, n int) string

用途

拷贝n。失败时 throw。

参数

dst Buffer

目标（Buffer）

src Cursor

源数据（Cursor）

n int

数量、长度或上限（int）

返回

string — 结果字符串

struct LimitCursor

pub struct LimitCursor {
    pub src Cursor
    pub n int
}

用途

公开结构体 `LimitCursor`。

参数

src Cursor

源数据

n int

数量、长度或上限

limit_cursor

pub fn limit_cursor(src Cursor, n int) LimitCursor

用途

limit游标。

参数

src Cursor

源数据（Cursor）

n int

数量、长度或上限（int）

返回

LimitCursor — 该类型的值

(LimitCursor) remaining

pub fn (l LimitCursor) remaining() int

用途

在 `LimitCursor` 上调用 `remaining`。

参数

l LimitCursor

接收者 LimitCursor（值接收者）

返回

int — 该类型的值

(&mut LimitCursor) read_n

pub fn (l &mut LimitCursor) read_n(n int) string

用途

`&mut LimitCursor` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

参数

l &mut LimitCursor

接收者 &mut LimitCursor（可变借用）

n int

数量、长度或上限（int）

返回

string — 结果字符串

struct Discard

pub struct Discard {
    pub n int
}

用途

公开结构体 `Discard`。

参数

n int

数量、长度或上限

discard

pub fn discard() Discard

用途

丢弃。

参数

无

返回

Discard — 该类型的值

(&mut Discard) write

pub fn (d &mut Discard) write(data &string) int

用途

`&mut Discard` 上的方法：写入数据，返回写入的字节数。

参数

d &mut Discard

接收者 &mut Discard（可变借用）

data &string

数据（借用，调用方仍持有；类型 &string）

返回

int — 写入的字节数

(Discard) written

pub fn (d Discard) written() int

用途

在 `Discard` 上调用 `written`。

参数

d Discard

接收者 Discard（值接收者）

返回

int — 该类型的值

struct MultiCursor

pub struct MultiCursor {
    pub chunks []string
    pub i int
    pub off int
}

用途

公开结构体 `MultiCursor`。

参数

chunks []string

字段（[]string）

i int

下标或整数

off int

偏移

multi_cursor

pub fn multi_cursor(parts <-> string) MultiCursor

用途

multi游标。

参数

parts <-> string

可变参数，类型 string，在函数体内是 []string

返回

MultiCursor — 该类型的值

(&mut MultiCursor) read_n

pub fn (m &mut MultiCursor) read_n(n int) string

用途

`&mut MultiCursor` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

参数

m &mut MultiCursor

接收者 &mut MultiCursor（可变借用）

n int

数量、长度或上限（int）

返回

string — 结果字符串

struct MultiBuffer

pub struct MultiBuffer {
    pub parts []string
}

用途

公开结构体 `MultiBuffer`。

参数

parts []string

各段

multi_buffer

pub fn multi_buffer(n int) MultiBuffer

用途

multi缓冲。

参数

n int

数量、长度或上限（int）

返回

MultiBuffer — 该类型的值

(&mut MultiBuffer) write

pub fn (m &mut MultiBuffer) write(data &string) int

用途

`&mut MultiBuffer` 上的方法：写入数据，返回写入的字节数。

参数

m &mut MultiBuffer

接收者 &mut MultiBuffer（可变借用）

data &string

数据（借用，调用方仍持有；类型 &string）

返回

int — 写入的字节数

(&MultiBuffer) text

pub fn (m &MultiBuffer) text(i int) string

用途

`&MultiBuffer` 上的方法：返回当前文本。

参数

m &MultiBuffer

接收者 &MultiBuffer（借用）

i int

下标或整数（int）

返回

string — 结果字符串

struct Tee

pub struct Tee {
    pub src Cursor
    pub dst Buffer
}

用途

公开结构体 `Tee`。

参数

src Cursor

源数据

dst Buffer

目标

tee

pub fn tee(src Cursor, dst Buffer) Tee

用途

tee，返回 Tee。

参数

src Cursor

源数据（Cursor）

dst Buffer

目标（Buffer）

返回

Tee — 该类型的值

(&mut Tee) read_n

pub fn (t &mut Tee) read_n(n int) string

用途

`&mut Tee` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

参数

t &mut Tee

接收者 &mut Tee（可变借用）

n int

数量、长度或上限（int）

返回

string — 结果字符串

(&Tee) copied

pub fn (t &Tee) copied() string

用途

在 `&Tee` 上调用 `copied`。

参数

t &Tee

接收者 &Tee（借用）

返回

string — 结果字符串

struct SectionCursor

pub struct SectionCursor {
    pub data string
    pub base int
    pub limit int
    pub off int
}

用途

公开结构体 `SectionCursor`。

参数

data string

数据

base int

进制

limit int

字段（int）

off int

偏移

section_cursor

pub fn section_cursor(s string, off int, n int) SectionCursor

用途

section游标。

参数

s string

源字符串（string）

off int

偏移（int）

n int

数量、长度或上限（int）

返回

SectionCursor — 该类型的值

(&mut SectionCursor) read_n

pub fn (s &mut SectionCursor) read_n(n int) string

用途

`&mut SectionCursor` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

参数

s &mut SectionCursor

接收者 &mut SectionCursor（可变借用）

n int

数量、长度或上限（int）

返回

string — 结果字符串

(&SectionCursor) size

pub fn (s &SectionCursor) size() int

用途

`&SectionCursor` 上的方法：返回尺寸。

参数

s &SectionCursor

接收者 &SectionCursor（借用）

返回

int — 该类型的值

(&mut SectionCursor) seek

pub fn (s &mut SectionCursor) seek(offset int, whence int) int

用途

`&mut SectionCursor` 上的方法：按 whence 把读位置移到 offset。whence 0/1/2 分别为绝对、相对、从末尾。失败时 throw。

参数

s &mut SectionCursor

接收者 &mut SectionCursor（可变借用）

offset int

偏移（int）

whence int

定位基准：0 起点 / 1 当前 / 2 末尾（int）

返回

int — 该类型的值

(&SectionCursor) read_at

pub fn (s &SectionCursor) read_at(n int, off int) string

用途

`&SectionCursor` 上的方法：从偏移 off 起最多读 n 字节。失败时 throw。

参数

s &SectionCursor

接收者 &SectionCursor（借用）

n int

数量、长度或上限（int）

off int

偏移（int）

返回

string — 结果字符串

struct PipeReader

pub struct PipeReader {
    pub r chan string
    pub buf string
    pub off int
}

用途

公开结构体 `PipeReader`。

参数

r chan string

rune（Unicode 码点）

buf string

缓冲

off int

偏移

struct PipeWriter

pub struct PipeWriter {
    pub w chan string
    pub closed int
}

用途

公开结构体 `PipeWriter`。

参数

w chan string

写入侧 / 宽度

closed int

字段（int）

struct Pipe

pub struct Pipe {
    pub r PipeReader
    pub w PipeWriter
}

用途

公开结构体 `Pipe`。

参数

r PipeReader

rune（Unicode 码点）

w PipeWriter

写入侧 / 宽度

pipe

pub fn pipe() Pipe

用途

pipe，返回 Pipe。

参数

无

返回

Pipe — 该类型的值

(&mut PipeReader) read_n

pub fn (p &mut PipeReader) read_n(n int) string

用途

`&mut PipeReader` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

参数

p &mut PipeReader

接收者 &mut PipeReader（可变借用）

n int

数量、长度或上限（int）

返回

string — 结果字符串

(PipeWriter) write

pub fn (w PipeWriter) write(data &string) int

用途

`PipeWriter` 上的方法：写入数据，返回写入的字节数。失败时 throw。

参数

w PipeWriter

接收者 PipeWriter（值接收者）

data &string

数据（借用，调用方仍持有；类型 &string）

返回

int — 写入的字节数

(&mut PipeWriter) close

pub fn (w &mut PipeWriter) close() int

用途

`&mut PipeWriter` 上的方法：关闭资源。

参数

w &mut PipeWriter

接收者 &mut PipeWriter（可变借用）

返回

int — 该类型的值

enum ReadResult

pub enum ReadResult {
    Data(string)
    End(string)
    Failed(string, errors.Error)
}

用途

公开枚举 `ReadResult`；变体与载荷见声明。

参数

无

enum WriteResult

pub enum WriteResult {
    Written(int)
    Failed(int, errors.Error)
    Unknown(errors.Error)
}

用途

公开枚举 `WriteResult`；变体与载荷见声明。

参数

无

enum CopyResult

pub enum CopyResult {
    Copied(int)
    Failed(int, errors.Error)
    Uncertain(int, errors.Error)
}

用途

公开枚举 `CopyResult`；变体与载荷见声明。

参数

无

struct@ ProgressReader

pub struct@ ProgressReader {
    fn read_result(int) ReadResult
}

用途

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

参数

read_result fn read_result(int) ReadResult

`ProgressReader` 上的方法：读取结果。

(ProgressReader) read_result

fn read_result(int) ReadResult

用途

`ProgressReader` 上的方法：读取结果。

参数

self Self

接收者 Self（值接收者）

int int

int（int）

返回

ReadResult — 该类型的值

struct@ ProgressWriter

pub struct@ ProgressWriter {
    fn write_result(string) WriteResult
}

用途

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

参数

write_result fn write_result(string) WriteResult

`ProgressWriter` 上的方法：写入结果。

(ProgressWriter) write_result

fn write_result(string) WriteResult

用途

`ProgressWriter` 上的方法：写入结果。

参数

self Self

接收者 Self（值接收者）

string string

string（string）

返回

WriteResult — 该类型的值

struct LegacyReader#R:StreamReader

pub struct LegacyReader#R:StreamReader {
    pub src R
}

用途

公开结构体 `LegacyReader#R:StreamReader`。

参数

src R

源数据

struct LegacyWriter#W:StreamWriter

pub struct LegacyWriter#W:StreamWriter {
    pub dst W
}

用途

公开结构体 `LegacyWriter#W:StreamWriter`。

参数

dst W

目标

progress_reader

pub fn progress_reader#R:StreamReader(src R) LegacyReader#R

用途

progress读取器。

参数

src R

源数据（R）

返回

LegacyReader#R — 该类型的值

progress_writer

pub fn progress_writer#W:StreamWriter(dst W) LegacyWriter#W

用途

progress写入器。

参数

dst W

目标（W）

返回

LegacyWriter#W — 该类型的值

(&mut LegacyReader#R) read_result

pub fn (r &mut LegacyReader#R) read_result(n int) ReadResult

用途

`&mut LegacyReader#R` 上的方法：读取结果。

参数

r &mut LegacyReader#R

接收者 &mut LegacyReader#R（可变借用）

n int

数量、长度或上限（int）

返回

ReadResult — 该类型的值

(&mut LegacyWriter#W) write_result

pub fn (w &mut LegacyWriter#W) write_result(data string) WriteResult

用途

`&mut LegacyWriter#W` 上的方法：写入结果。

参数

w &mut LegacyWriter#W

接收者 &mut LegacyWriter#W（可变借用）

data string

数据（string）

返回

WriteResult — 该类型的值

copy_result

pub fn copy_result#W:ProgressWriter,R:ProgressReader(dst &mut W, src &mut R) CopyResult

用途

拷贝结果。

参数

dst &mut W

目标（独占借用；类型 &mut W）

src &mut R

源数据（独占借用；类型 &mut R）

返回

CopyResult — 该类型的值

copy_result_buffer

pub fn copy_result_buffer#W:ProgressWriter,R:ProgressReader(dst &mut W, src &mut R, size int) CopyResult

用途

拷贝结果缓冲。

参数

dst &mut W

目标（独占借用；类型 &mut W）

src &mut R

源数据（独占借用；类型 &mut R）

size int

size（int）

返回

CopyResult — 该类型的值

copy_result_n

pub fn copy_result_n#W:ProgressWriter,R:ProgressReader(dst &mut W, src &mut R, n int) CopyResult

用途

拷贝结果n。

参数

dst &mut W

目标（独占借用；类型 &mut W）

src &mut R

源数据（独占借用；类型 &mut R）

n int

数量、长度或上限（int）

返回

CopyResult — 该类型的值

(&mut Cursor) read_result

pub fn (c &mut Cursor) read_result(n int) ReadResult

用途

`&mut Cursor` 上的方法：读取结果。

参数

c &mut Cursor

接收者 &mut Cursor（可变借用）

n int

数量、长度或上限（int）

返回

ReadResult — 该类型的值

(&mut Buffer) read_result

pub fn (b &mut Buffer) read_result(n int) ReadResult

用途

`&mut Buffer` 上的方法：读取结果。

参数

b &mut Buffer

接收者 &mut Buffer（可变借用）

n int

数量、长度或上限（int）

返回

ReadResult — 该类型的值

(&mut Buffer) write_result

pub fn (b &mut Buffer) write_result(data string) WriteResult

用途

`&mut Buffer` 上的方法：写入结果。

参数

b &mut Buffer

接收者 &mut Buffer（可变借用）

data string

数据（string）

返回

WriteResult — 该类型的值

(&mut Discard) write_result

pub fn (d &mut Discard) write_result(data string) WriteResult

用途

`&mut Discard` 上的方法：写入结果。

参数

d &mut Discard

接收者 &mut Discard（可变借用）

data string

数据（string）

返回

WriteResult — 该类型的值

enum ReadInto

pub enum ReadInto {
    Filled(int)
    End(int)
    Failed(int, errors.Error)
}

用途

公开枚举 `ReadInto`；变体与载荷见声明。

参数

无

(&mut Cursor) read_into

pub fn (c &mut Cursor) read_into(dst &mut []int, off int, n int) ReadInto

用途

`&mut Cursor` 上的方法：读取into。

参数

c &mut Cursor

接收者 &mut Cursor（可变借用）

dst &mut []int

目标（独占借用；类型 &mut []int）

off int

偏移（int）

n int

数量、长度或上限（int）

返回

ReadInto — 该类型的值

(&mut Buffer) read_into

pub fn (b &mut Buffer) read_into(dst &mut []int, off int, n int) ReadInto

用途

`&mut Buffer` 上的方法：读取into。

参数

b &mut Buffer

接收者 &mut Buffer（可变借用）

dst &mut []int

目标（独占借用；类型 &mut []int）

off int

偏移（int）

n int

数量、长度或上限（int）

返回

ReadInto — 该类型的值

read_into

pub fn read_into#R:ProgressReader(src &mut R, dst &mut []int, off int, n int) ReadInto

用途

读取into。

参数

src &mut R

源数据（独占借用；类型 &mut R）

dst &mut []int

目标（独占借用；类型 &mut []int）

off int

偏移（int）

n int

数量、长度或上限（int）

返回

ReadInto — 该类型的值

struct@ StreamReader

pub struct@ StreamReader {
    fn read_n(int) string
}

用途

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

参数

read_n fn read_n(int) string

`StreamReader` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

(StreamReader) read_n

fn read_n(int) string

用途

`StreamReader` 上的方法：最多读 n 字节；到末尾可返回更短或空串。

参数

self Self

接收者 Self（值接收者）

int int

int（int）

返回

string — 结果字符串

struct@ StreamWriter

pub struct@ StreamWriter {
    fn write_str(string) int
}

用途

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

参数

write_str fn write_str(string) int

`StreamWriter` 上的方法：写入字符串。

(StreamWriter) write_str

fn write_str(string) int

用途

`StreamWriter` 上的方法：写入字符串。

参数

self Self

接收者 Self（值接收者）

string string

string（string）

返回

int — 该类型的值

copy_stream

pub fn copy_stream#W:StreamWriter,R:StreamReader(dst &mut W, src &mut R) int

用途

拷贝流。失败时 throw。

参数

dst &mut W

目标（独占借用；类型 &mut W）

src &mut R

源数据（独占借用；类型 &mut R）

返回

int — 该类型的值

copy_stream_buffer

pub fn copy_stream_buffer#W:StreamWriter,R:StreamReader(dst &mut W, src &mut R, size int) int

用途

拷贝流缓冲。失败时 throw。

参数

dst &mut W

目标（独占借用；类型 &mut W）

src &mut R

源数据（独占借用；类型 &mut R）

size int

size（int）

返回

int — 该类型的值

copy_stream_n

pub fn copy_stream_n#W:StreamWriter,R:StreamReader(dst &mut W, src &mut R, n int) int

用途

拷贝流n。失败时 throw。

参数

dst &mut W

目标（独占借用；类型 &mut W）

src &mut R

源数据（独占借用；类型 &mut R）

n int

数量、长度或上限（int）

返回

int — 该类型的值

(&mut Discard) write_str

pub fn (d &mut Discard) write_str(data string) int

用途

`&mut Discard` 上的方法：写入字符串。

参数

d &mut Discard

接收者 &mut Discard（可变借用）

data string

数据（string）

返回

int — 该类型的值