XU XUv0.8.8
中文

API

#bufio/file

import: #bufio/file

counts: 4 fns, 4 methods, 2 types, 0 consts, 0 ifaces

File-backed buffered I/O ( bufio.NewReader(os.File) shape). Kept out of #bufio so importing strings-only bufio does not pull #os.

struct FileReader

XuAPI
pub struct FileReader {
    pub src os.File
    pub buf string
    pub r int
    pub err string
    pub size int
    pub last_byte int
}

Purpose

Public struct `FileReader`.

Parameters

src os.File
source
buf string
buffer
r int
rune (Unicode code point)
err string
error
size int
field (int)
last_byte int
field (int)

struct FileWriter

XuAPI
pub struct FileWriter {
    pub dst os.File
    pub buf string
    pub size int
    pub err string
}

Purpose

Public struct `FileWriter`.

Parameters

dst os.File
destination
buf string
buffer
size int
field (int)
err string
error

new_reader

XuAPI
pub fn new_reader(src os.File) FileReader

Purpose

Construct reader.

Parameters

src os.File
source (os.File)

Returns

FileReader — a value of this type

new_reader_size

XuAPI
pub fn new_reader_size(src os.File, size int) FileReader

Purpose

Construct reader size.

Parameters

src os.File
source (os.File)
size int
size (int)

Returns

FileReader — a value of this type

new_writer

XuAPI
pub fn new_writer(dst os.File) FileWriter

Purpose

Construct writer.

Parameters

dst os.File
destination (os.File)

Returns

FileWriter — a value of this type

new_writer_size

XuAPI
pub fn new_writer_size(dst os.File, size int) FileWriter

Purpose

Construct writer size.

Parameters

dst os.File
destination (os.File)
size int
size (int)

Returns

FileWriter — a value of this type

(&mut FileReader) read_byte

XuAPI
pub fn (r &mut FileReader) read_byte() int

Purpose

Method on `&mut FileReader`: read one byte; throws on failure. Throws on failure.

Parameters

r &mut FileReader
receiver &mut FileReader (exclusive borrow)

Returns

int — a value of this type

(&mut FileReader) read_string

XuAPI
pub fn (r &mut FileReader) read_string(delim int) string

Purpose

Method on `&mut FileReader`: read string. Throws on failure.

Parameters

r &mut FileReader
receiver &mut FileReader (exclusive borrow)
delim int
delim (int)

Returns

string — result string

(&mut FileWriter) write

XuAPI
pub fn (w &mut FileWriter) write(data string) int

Purpose

Bounded staging; return bytes accepted from this call, not the flush count. A failed flush remains sticky and retains bytes not confirmed as written. Throws on failure.

Parameters

w &mut FileWriter
receiver &mut FileWriter (exclusive borrow)
data string
data (string)

Returns

int — bytes written

(&mut FileWriter) flush

XuAPI
pub fn (w &mut FileWriter) flush() int

Purpose

Method on `&mut FileWriter`: flush buffered data. Throws on failure.

Parameters

w &mut FileWriter
receiver &mut FileWriter (exclusive borrow)

Returns

int — a value of this type