API
#bufioReader/Writer, Scanner (lines/words/bytes), and generic borrowed-stream wrappers.
struct Readerpub struct Reader {
pub src io.Buffer
pub buf string
pub r int
pub err string
pub size int
pub last_byte int
pub last_rune int
}Public struct `Reader`.
src io.Bufferbuf stringr interr stringsize intlast_byte intlast_rune intstruct Writerpub struct Writer {
pub dst io.Buffer
pub buf string
pub size int
pub err string
}Public struct `Writer`.
dst io.Bufferbuf stringsize interr stringnew_readerpub fn new_reader(src io.Buffer) ReaderConstruct reader.
src io.BufferReader — a value of this type
new_reader_sizepub fn new_reader_size(src io.Buffer, size int) ReaderConstruct reader size.
src io.Buffersize intReader — a value of this type
new_writerpub fn new_writer(dst io.Buffer) WriterConstruct writer.
dst io.BufferWriter — a value of this type
new_writer_sizepub fn new_writer_size(dst io.Buffer, size int) WriterConstruct writer size.
dst io.Buffersize intWriter — a value of this type
struct RuneReadpub struct RuneRead {
pub ch int
pub size int
}read_byte returns the next byte, or throws at end of input.
ch intsize int(&mut Reader) read_runepub fn (r &mut Reader) read_rune() RuneReadMethod on `&mut Reader`: read one UTF-8 rune. Throws on failure.
r &mut ReaderRuneRead — a value of this type
(&mut Reader) read_bytepub fn (r &mut Reader) read_byte() intMethod on `&mut Reader`: read one byte; throws on failure. Throws on failure.
r &mut Readerint — a value of this type
(&mut Reader) read_stringpub fn (r &mut Reader) read_string(delim int) stringMethod on `&mut Reader`: read string.
r &mut Readerdelim intstring — result string
(&mut Reader) read_linepub fn (r &mut Reader) read_line() stringread_line reads until '\n' or eof and strips the trailing '\n' (and a preceding '\r', i.e. CRLF) — a simplified ReadLine.
r &mut Readerstring — result string
(&mut Reader) peekpub fn (r &mut Reader) peek(n int) stringpeek returns the next n bytes without consuming them. n must be in 0..size; n > size throws ( bufio.ErrBufferFull). At eof with fewer than n bytes buffered it returns what is available (or throws). Throws on failure.
r &mut Readern intstring — result string
(&mut Writer) flushpub fn (w &mut Writer) flush() intMethod on `&mut Writer`: flush buffered data. Throws on failure.
w &mut Writerint — a value of this type
(&mut Writer) write_stringpub fn (w &mut Writer) write_string(s string) intRetain at most size bytes. Preserve the existing auto-flush-on-full contract. Errors are sticky until reset; never silently claim an unsuccessful write. Throws on failure.
w &mut Writers stringint — bytes written
(&mut Writer) bytespub fn (w &mut Writer) bytes() stringbytes returns the sink's written bytes (for round-trip tests); it does not consume the sink's read position.
w &mut Writerstring — result string
(&mut Reader) bufferedpub fn (r &mut Reader) buffered() intCall `buffered` on `&mut Reader`.
r &mut Readerint — a value of this type
(&mut Reader) discardpub fn (r &mut Reader) discard(n int) intCall `discard` on `&mut Reader`. Throws on failure.
r &mut Readern intint — a value of this type
(&mut Reader) read_bytespub fn (r &mut Reader) read_bytes(delim int) stringMethod on `&mut Reader`: read through delim (inclusive).
r &mut Readerdelim intstring — result string
(&mut Reader) unread_bytepub fn (r &mut Reader) unread_byte() intunread_byte puts back the last byte from a successful non-peek read ( UnreadByte). Peek/discard/error invalidate it; twice in a row throws. Throws on failure.
r &mut Readerint — a value of this type
(&mut Reader) unread_runepub fn (r &mut Reader) unread_rune() intMethod on `&mut Reader`: unread the last rune. Throws on failure.
r &mut Readerint — a value of this type
(&mut Reader) read_slicepub fn (r &mut Reader) read_slice(delim int) stringread_slice reads until delim (inclusive) in the current buffer ( ReadSlice). It does not accumulate across a full buffer: if the buffer fills with no delim, it returns that chunk ( also returns ErrBufferFull Xu returns the bytes and does not throw — caller sees no delim). eof with leftover returns the leftover; empty eof throws. Throws on failure.
r &mut Readerdelim intstring — result string
(&mut Reader) resetpub fn (r &mut Reader) reset(src io.Buffer)Method on `&mut Reader`: clear internal state so the value can be reused.
r &mut Readersrc io.Buffer(&mut Writer) write_bytepub fn (w &mut Writer) write_byte(c int) intMethod on `&mut Writer`: write one byte. Throws on failure.
w &mut Writerc intint — bytes written
(&mut Writer) write_runepub fn (w &mut Writer) write_rune(r int) intMethod on `&mut Writer`: write a rune as UTF-8. Throws on failure.
w &mut Writerr intint — bytes written
(&mut Writer) bufferedpub fn (w &mut Writer) buffered() intCall `buffered` on `&mut Writer`.
w &mut Writerint — a value of this type
(&Reader) sizepub fn (r &Reader) size() intMethod on `&Reader`: return the size.
r &Readerint — a value of this type
(&Writer) sizepub fn (w &Writer) size() intMethod on `&Writer`: return the size.
w &Writerint — a value of this type
(&Writer) availablepub fn (w &Writer) available() intCall `available` on `&Writer`.
w &Writerint — a value of this type
(&mut Writer) resetpub fn (w &mut Writer) reset(dst io.Buffer)reset discards unflushed bytes and points at a new sink ( Writer.Reset).
w &mut Writerdst io.Bufferconst mode_linespub const mode_lines = 0Scanner is `bufio.Scanner` over an in-memory snapshot of `io.Buffer`. Default split is ScanLines. Custom SplitFunc via `split_func`. Built-in modes: mode_lines / mode_words / mode_bytes. Scan is a single forward index walk — O(n) total, one token string per successful scan. Value `0`.
none
const mode_wordspub const mode_words = 1Public constant `mode_words`. Value `1`.
none
const mode_bytespub const mode_bytes = 2Public constant `mode_bytes`. Value `2`.
none
const mode_funcpub const mode_func = 3Public constant `mode_func`. Value `3`.
none
struct SplitResultpub struct SplitResult {
pub advance int
pub token string
pub err string
}SplitResult mirrors SplitFunc's (advance, token, err).
advance inttoken stringerr stringsplit_okpub fn split_ok(advance int, token string) SplitResultSplit ok.
advance inttoken stringSplitResult — a value of this type
split_failpub fn split_fail(msg string) SplitResultSplit fail.
msg stringSplitResult — a value of this type
struct Scannerpub struct Scanner {
pub data string
pub pos int
pub token string
pub err string
pub mode int
pub has_split int
pub split_f fn(string, int) SplitResult
}Public struct `Scanner`.
data stringpos inttoken stringerr stringmode inthas_split intsplit_f fn(string, int) SplitResultnew_scannerpub fn new_scanner(src io.Buffer) ScannerConstruct scanner.
src io.BufferScanner — a value of this type
(&mut Scanner) splitpub fn (s &mut Scanner) split(mode int)Method on `&mut Scanner`: split on the separator.
s &mut Scannermode int(&mut Scanner) split_funcpub fn (s &mut Scanner) split_func(f fn(string, int) SplitResult)Method on `&mut Scanner`: split callback.
s &mut Scannerf fn(string, int) SplitResultscan_linespub fn scan_lines(data string, at_eof int) SplitResultPublic SplitFunc-shaped helpers ( ScanLines / ScanWords / ScanBytes).
data stringat_eof intSplitResult — a value of this type
scan_wordspub fn scan_words(data string, at_eof int) SplitResultScan words.
data stringat_eof intSplitResult — a value of this type
scan_bytespub fn scan_bytes(data string, at_eof int) SplitResultScan bytes.
data stringat_eof intSplitResult — a value of this type
(&mut Scanner) scanpub fn (s &mut Scanner) scan() boolCall `scan` on `&mut Scanner`.
s &mut Scannerbool — true or false
(&mut Scanner) textpub fn (s &mut Scanner) text() stringMethod on `&mut Scanner`: return the current text.
s &mut Scannerstring — result string
(&mut Scanner) err_textpub fn (s &mut Scanner) err_text() stringMethod on `&mut Scanner`: err text.
s &mut Scannerstring — result string
struct ResultReader#R:ProgressReaderpub struct ResultReader#R:ProgressReader {
pub src R
}Pending owns the terminal error until its accompanying bytes are drained. map.take transfers the enum without partially moving an owner field.
src Rstruct ResultWriter#W:ProgressWriterpub struct ResultWriter#W:ProgressWriter {
pub dst W
}Public struct `ResultWriter#W:ProgressWriter`.
dst Wnew_result_readerpub fn new_result_reader#R:ProgressReader(src R) ResultReader#RConstruct result reader.
src RResultReader#R — a value of this type
new_result_reader_sizepub fn new_result_reader_size#R:ProgressReader(src R, size int) ResultReader#RConstruct result reader size.
src Rsize intResultReader#R — a value of this type
new_result_writerpub fn new_result_writer#W:ProgressWriter(dst W) ResultWriter#WConstruct result writer.
dst WResultWriter#W — a value of this type
new_result_writer_sizepub fn new_result_writer_size#W:ProgressWriter(dst W, size int) ResultWriter#WConstruct result writer size.
dst Wsize intResultWriter#W — a value of this type
(&mut ResultReader#R) read_resultpub fn (r &mut ResultReader#R) read_result(n int) io.ReadResultMethod on `&mut ResultReader#R`: read result.
r &mut ResultReader#Rn intio.ReadResult — a value of this type
(&ResultReader#R) bufferedpub fn (r &ResultReader#R) buffered() intCall `buffered` on `&ResultReader#R`.
r &ResultReader#Rint — a value of this type
(&mut ResultReader#R) resetpub fn (r &mut ResultReader#R) reset(src R)Method on `&mut ResultReader#R`: clear internal state so the value can be reused.
r &mut ResultReader#Rsrc R(&mut ResultReader#R) read_npub fn (r &mut ResultReader#R) read_n(n int) stringA legacy read defers terminal errors until the returned bytes are consumed. The first structured failure transfers its typed error to the caller subsequent sticky failures recreate its message, not its dynamic type. Throws on failure.
r &mut ResultReader#Rn intstring — result string
(&mut ResultWriter#W) flush_resultpub fn (w &mut ResultWriter#W) flush_result() io.WriteResultMethod on `&mut ResultWriter#W`: flush result.
w &mut ResultWriter#Wio.WriteResult — a value of this type
(&mut ResultWriter#W) write_resultpub fn (w &mut ResultWriter#W) write_result(data string) io.WriteResultProgress means bytes accepted by this buffer, including queued bytes. flush_result instead reports the underlying destination's progress.
w &mut ResultWriter#Wdata stringio.WriteResult — a value of this type
(&ResultWriter#W) bufferedpub fn (w &ResultWriter#W) buffered() intCall `buffered` on `&ResultWriter#W`.
w &ResultWriter#Wint — a value of this type
(&ResultWriter#W) pendingpub fn (w &ResultWriter#W) pending() stringCall `pending` on `&ResultWriter#W`.
w &ResultWriter#Wstring — result string
(&mut ResultWriter#W) resetpub fn (w &mut ResultWriter#W) reset(dst W)Method on `&mut ResultWriter#W`: clear internal state so the value can be reused.
w &mut ResultWriter#Wdst W(&mut ResultWriter#W) flushpub fn (w &mut ResultWriter#W) flush() intMethod on `&mut ResultWriter#W`: flush buffered data. Throws on failure.
w &mut ResultWriter#Wint — a value of this type
(&mut ResultWriter#W) write_strpub fn (w &mut ResultWriter#W) write_str(data string) intMethod on `&mut ResultWriter#W`: write a string. Throws on failure.
w &mut ResultWriter#Wdata stringint — a value of this type
struct BufferedReader#R:StreamReaderpub struct BufferedReader#R:StreamReader {
pub src R
pub buf string
pub r int
pub err string
pub size int
pub last_byte int
pub last_rune int
}Owning, concrete endpoint wrappers. Methods borrow the endpoint field every read/write preserves its position and propagates its errors. This is chunked string I/O, not borrowed/shared byte-buffer I/O.
src Rbuf stringr interr stringsize intlast_byte intlast_rune intstruct BufferedWriter#W:StreamWriterpub struct BufferedWriter#W:StreamWriter {
pub dst W
pub buf string
pub size int
pub err string
}Public struct `BufferedWriter#W:StreamWriter`.
dst Wbuf stringsize interr stringnew_stream_readerpub fn new_stream_reader#R:StreamReader(src R) BufferedReader#RConstruct stream reader.
src RBufferedReader#R — a value of this type
new_stream_reader_sizepub fn new_stream_reader_size#R:StreamReader(src R, size int) BufferedReader#RConstruct stream reader size.
src Rsize intBufferedReader#R — a value of this type
new_stream_writerpub fn new_stream_writer#W:StreamWriter(dst W) BufferedWriter#WConstruct stream writer.
dst WBufferedWriter#W — a value of this type
new_stream_writer_sizepub fn new_stream_writer_size#W:StreamWriter(dst W, size int) BufferedWriter#WConstruct stream writer size.
dst Wsize intBufferedWriter#W — a value of this type
(&mut BufferedReader#R) read_runepub fn (r &mut BufferedReader#R) read_rune() RuneReadMethod on `&mut BufferedReader#R`: read one UTF-8 rune. Throws on failure.
r &mut BufferedReader#RRuneRead — a value of this type
(&mut BufferedReader#R) read_bytepub fn (r &mut BufferedReader#R) read_byte() intMethod on `&mut BufferedReader#R`: read one byte; throws on failure. Throws on failure.
r &mut BufferedReader#Rint — a value of this type
(&mut BufferedReader#R) read_stringpub fn (r &mut BufferedReader#R) read_string(delim int) stringMethod on `&mut BufferedReader#R`: read string.
r &mut BufferedReader#Rdelim intstring — result string
(&mut BufferedReader#R) read_linepub fn (r &mut BufferedReader#R) read_line() stringMethod on `&mut BufferedReader#R`: read line.
r &mut BufferedReader#Rstring — result string
(&mut BufferedReader#R) peekpub fn (r &mut BufferedReader#R) peek(n int) stringCall `peek` on `&mut BufferedReader#R`. Throws on failure.
r &mut BufferedReader#Rn intstring — result string
(&mut BufferedWriter#W) flushpub fn (w &mut BufferedWriter#W) flush() intMethod on `&mut BufferedWriter#W`: flush buffered data. Throws on failure.
w &mut BufferedWriter#Wint — a value of this type
(&mut BufferedWriter#W) write_stringpub fn (w &mut BufferedWriter#W) write_string(s string) intMethod on `&mut BufferedWriter#W`: write a string and return the byte count. Throws on failure.
w &mut BufferedWriter#Ws stringint — bytes written
(&mut BufferedReader#R) bufferedpub fn (r &mut BufferedReader#R) buffered() intCall `buffered` on `&mut BufferedReader#R`.
r &mut BufferedReader#Rint — a value of this type
(&mut BufferedReader#R) discardpub fn (r &mut BufferedReader#R) discard(n int) intCall `discard` on `&mut BufferedReader#R`. Throws on failure.
r &mut BufferedReader#Rn intint — a value of this type
(&mut BufferedReader#R) read_bytespub fn (r &mut BufferedReader#R) read_bytes(delim int) stringMethod on `&mut BufferedReader#R`: read through delim (inclusive).
r &mut BufferedReader#Rdelim intstring — result string
(&mut BufferedReader#R) unread_bytepub fn (r &mut BufferedReader#R) unread_byte() intMethod on `&mut BufferedReader#R`: unread the last byte. Throws on failure.
r &mut BufferedReader#Rint — a value of this type
(&mut BufferedReader#R) unread_runepub fn (r &mut BufferedReader#R) unread_rune() intMethod on `&mut BufferedReader#R`: unread the last rune. Throws on failure.
r &mut BufferedReader#Rint — a value of this type
(&mut BufferedReader#R) read_slicepub fn (r &mut BufferedReader#R) read_slice(delim int) stringMethod on `&mut BufferedReader#R`: read slice. Throws on failure.
r &mut BufferedReader#Rdelim intstring — result string
(&mut BufferedReader#R) resetpub fn (r &mut BufferedReader#R) reset(src R)Method on `&mut BufferedReader#R`: clear internal state so the value can be reused.
r &mut BufferedReader#Rsrc R(&mut BufferedWriter#W) write_bytepub fn (w &mut BufferedWriter#W) write_byte(c int) intMethod on `&mut BufferedWriter#W`: write one byte. Throws on failure.
w &mut BufferedWriter#Wc intint — bytes written
(&mut BufferedWriter#W) write_runepub fn (w &mut BufferedWriter#W) write_rune(r int) intMethod on `&mut BufferedWriter#W`: write a rune as UTF-8. Throws on failure.
w &mut BufferedWriter#Wr intint — bytes written
(&mut BufferedWriter#W) bufferedpub fn (w &mut BufferedWriter#W) buffered() intCall `buffered` on `&mut BufferedWriter#W`.
w &mut BufferedWriter#Wint — a value of this type
(&BufferedReader#R) sizepub fn (r &BufferedReader#R) size() intMethod on `&BufferedReader#R`: return the size.
r &BufferedReader#Rint — a value of this type
(&BufferedWriter#W) sizepub fn (w &BufferedWriter#W) size() intMethod on `&BufferedWriter#W`: return the size.
w &BufferedWriter#Wint — a value of this type
(&BufferedWriter#W) availablepub fn (w &BufferedWriter#W) available() intCall `available` on `&BufferedWriter#W`.
w &BufferedWriter#Wint — a value of this type
(&mut BufferedWriter#W) resetpub fn (w &mut BufferedWriter#W) reset(dst W)Method on `&mut BufferedWriter#W`: clear internal state so the value can be reused.
w &mut BufferedWriter#Wdst W(&mut BufferedReader#R) read_npub fn (r &mut BufferedReader#R) read_n(n int) stringA zero-size read does not access the source and invalidates unread state. Return buffered bytes first; a deferred source error is reported once those bytes are consumed. A negative size is invalid. Returned chunks are owned. Throws on failure.
r &mut BufferedReader#Rn intstring — result string
(&mut BufferedWriter#W) write_strpub fn (w &mut BufferedWriter#W) write_str(data string) intMethod on `&mut BufferedWriter#W`: write a string. Throws on failure.
w &mut BufferedWriter#Wdata stringint — a value of this type