• Go语言标准库_输入/输出


    Go语言标准库_输入/输出

    转载节选自《Go语言标准库》

    Reader 接口

    type Reader interface {
        Read(p []byte) (n int, err error)
    }
    

    Read 将 len(p) 个字节读取到 p 中。它返回读取的字节数 n(0 <= n <= len(p)) 以及任何遇到的错误。即使 Read 返回的 n < len(p),它也会在调用过程中使用 p 的全部作为暂存空间。若一些数据可用但不到 len(p) 个字节,Read 会照例返回可用的数据,而不是等待更多数据。

    当 Read 在成功读取 n > 0 个字节后遇到一个错误或 EOF (end-of-file),它就会返回读取的字节数。它会从相同的调用中返回(非nil的)错误或从随后的调用中返回错误(同时 n == 0)。 一般情况的一个例子就是 Reader 在输入流结束时会返回一个非零的字节数,同时返回的 err 不是 EOF 就是 nil。无论如何,下一个 Read 都应当返回 0, EOF。

    调用者应当总在考虑到错误 err 前处理 n > 0 的字节。这样做可以在读取一些字节,以及允许的 EOF 行为后正确地处理 I/O 错误。

    Writer

    type Writer interface {
        Write(p []byte) (n int, err error)
    }
    

    Write 将 len(p) 个字节从 p 中写入到基本数据流中。它返回从 p 中被写入的字节数 n(0 <= n <= len(p))以及任何遇到的引起写入提前停止的错误。若 Write 返回的 n < len(p),它就必须返回一个 非nil 的错误。

    实现了 io.Reader 接口或 io.Writer 接口的类型

    • os.File 同时实现了 io.Reader 和 io.Writer
    • strings.Reader 实现了 io.Reader
    • bufio.Reader/Writer 分别实现了 io.Reader 和 io.Writer
    • bytes.Buffer 同时实现了 io.Reader 和 io.Writer
    • bytes.Reader 实现了 io.Reader
    • compress/gzip.Reader/Writer 分别实现了 io.Reader 和 io.Writer
    • crypto/cipher.StreamReader/StreamWriter 分别实现了 io.Reader 和 io.Writer
    • crypto/tls.Conn 同时实现了 io.Reader 和 io.Writer
    • encoding/csv.Reader/Writer 分别实现了 io.Reader 和 io.Writer
    • mime/multipart.Part 实现了 io.Reader

    ReaderAt/WriterAt 接口

    type ReaderAt interface {
        ReadAt(p []byte, off int64) (n int, err error)
    }
    

    ReadAt 从基本输入源的偏移量 off 处开始,将 len(p) 个字节读取到 p 中。它返回读取的字节数 n(0 <= n <= len(p))以及任何遇到的错误。

    当 ReadAt 返回的 n < len(p) 时,它就会返回一个 非nil 的错误来解释 为什么没有返回更多的字节。在这一点上,ReadAt 比 Read 更严格。

    即使 ReadAt 返回的 n < len(p),它也会在调用过程中使用 p 的全部作为暂存空间。若一些数据可用但不到 len(p) 字节,ReadAt 就会阻塞直到所有数据都可用或产生一个错误。 在这一点上 ReadAt 不同于 Read。

    若 n = len(p) 个字节在输入源的的结尾处由 ReadAt 返回,那么这时 err == EOF 或者 err == nil。

    若 ReadAt 按查找偏移量从输入源读取,ReadAt 应当既不影响基本查找偏移量也不被它所影响。

    ReadAt 的客户端可对相同的输入源并行执行 ReadAt 调用。

    type WriterAt interface {
        WriteAt(p []byte, off int64) (n int, err error)
    }
    

    WriteAt 从 p 中将 len(p) 个字节写入到偏移量 off 处的基本数据流中。它返回从 p 中被写入的字节数 n(0 <= n <= len(p))以及任何遇到的引起写入提前停止的错误。若 WriteAt 返回的 n < len(p),它就必须返回一个 非nil 的错误。

    若 WriteAt 按查找偏移量写入到目标中,WriteAt 应当既不影响基本查找偏移量也不被它所影响。

    若区域没有重叠,WriteAt 的客户端可对相同的目标并行执行 WriteAt 调用。

    ReaderFrom/WriterTo 接口

    type ReaderFrom interface {
        ReadFrom(r Reader) (n int64, err error)
    }
    

    ReadFrom 从 r 中读取数据,直到 EOF 或发生错误。其返回值 n 为读取的字节数。除 io.EOF 之外,在读取过程中遇到的任何错误也将被返回。

    如果 ReaderFrom 可用,Copy 函数就会使用它。

    type WriterTo interface {
        WriteTo(w Writer) (n int64, err error)
    }
    

    WriteTo 将数据写入 w 中,直到没有数据可写或发生错误。其返回值 n 为写入的字节数。 在写入过程中遇到的任何错误也将被返回。

    如果 WriterTo 可用,Copy 函数就会使用它。

    Seeker 接口

    type Seeker interface {
        Seek(offset int64, whence int) (ret int64, err error)
    }
    

    Seek 设置下一次 Read 或 Write 的偏移量为 offset,它的解释取决于 whence: 0 表示相对于文件的起始处,1 表示相对于当前的偏移,而 2 表示相对于其结尾处。 Seek 返回新的偏移量和一个错误,如果有的话。

    whence 的值,在 os 包中定义了相应的常量,应该使用这些常量

    const (
        SEEK_SET int = 0 // seek relative to the origin of the file
        SEEK_CUR int = 1 // seek relative to the current offset
        SEEK_END int = 2 // seek relative to the end
    )
    

    Closer接口

    type Closer interface {
        Close() error
    }
    

    ByteReader 和 ByteWriter

    type ByteReader interface {
        ReadByte() (c byte, err error)
    }
    
    type ByteWriter interface {
        WriteByte(c byte) error
    }
    

    在标准库中,有如下类型实现了 io.ByteReader 或 io.ByteWriter:

    • bufio.Reader/Writer 分别实现了io.ByteReader 和 io.ByteWriter
    • bytes.Buffer 同时实现了 io.ByteReader 和 io.ByteWriter
    • bytes.Reader 实现了 io.ByteReader
    • strings.Reader 实现了 io.ByteReader

    ByteScanner、RuneReader 和 RuneScanner

    type ByteScanner interface {
        ByteReader
        UnreadByte() error
    }
    

    UnreadByte 方法的意思是:将上一次 ReadByte 的字节还原,使得再次调用 ReadByte 返回的结果和上一次调用相同,也就是说,UnreadByte 是重置上一次的 ReadByte。注意,UnreadByte 调用之前必须调用了 ReadByte,且不能连续调用 UnreadByte。

    ReadCloser、ReadSeeker、ReadWriteCloser、ReadWriteSeeker、ReadWriter、WriteCloser 和 WriteSeeker 接口

    这些接口是上面介绍的接口的两个或三个组合而成的新接口。例如 ReadWriter 接口:

    type ReadWriter interface {
        Reader
        Writer
    }
    

    SectionReader 类型

    SectionReader 是一个 struct(没有任何导出的字段),实现了 Read, Seek 和 ReadAt,同时,内嵌了 ReaderAt 接口。结构定义如下:

    type SectionReader struct {
        r     ReaderAt    // 该类型最终的 Read/ReadAt 最终都是通过 r 的 ReadAt 实现
        base  int64        // NewSectionReader 会将 base 设置为 off
        off   int64        // 从 r 中的 off 偏移处开始读取数据
        limit int64        // limit - off = SectionReader 流的长度
    }
    

    从名称我们可以猜到,该类型读取数据流中部分数据。看一下

    func NewSectionReader(r ReaderAt, off int64, n int64) *SectionReader
    

    的文档说明就知道了:

    NewSectionReader 返回一个 SectionReader,它从 r 中的偏移量 off 处读取 n 个字节后以 EOF 停止。

    PipeReader 和 PipeWriter 类型

    PipeReader(一个没有任何导出字段的 struct)是管道的读取端。它实现了 io.Reader 和 io.Closer 接口。

    关于 Read 方法的说明:从管道中读取数据。该方法会堵塞,直到管道写入端开始写入数据或写入端关闭了。如果写入端关闭时带上了 error(即调用 CloseWithError 关闭),该方法返回的 err 就是写入端传递的error;否则 err 为 EOF。

    PipeWriter(一个没有任何导出字段的 struct)是管道的写入端。它实现了 io.Writer 和 io.Closer 接口。

    关于 Write 方法的说明:写数据到管道中。该方法会堵塞,直到管道读取端读完所有数据或读取端关闭了。如果读取端关闭时带上了 error(即调用 CloseWithError 关闭),该方法返回的 err 就是读取端传递的error;否则 err 为 ErrClosedPipe。

    Copy 和 CopyN 函数

    func Copy(dst Writer, src Reader) (written int64, err error)
    

    Copy 将 src 复制到 dst,直到在 src 上到达 EOF 或发生错误。它返回复制的字节数,如果有的话,还会返回在复制时遇到的第一个错误。

    成功的 Copy 返回 err == nil,而非 err == EOF。由于 Copy 被定义为从 src 读取直到 EOF 为止,因此它不会将来自 Read 的 EOF 当做错误来报告。

    若 dst 实现了 ReaderFrom 接口,其复制操作可通过调用 dst.ReadFrom(src) 实现。此外,若 src 实现了 WriterTo 接口,其复制操作可通过调用 src.WriteTo(dst) 实现。

    func CopyN(dst Writer, src Reader, n int64) (written int64, err error)
    

    CopyN 将 n 个字节从 src 复制到 dst。 它返回复制的字节数以及在复制时遇到的最早的错误。由于 Read 可以返回要求的全部数量及一个错误(包括 EOF),因此 CopyN 也能如此。

    若 dst 实现了 ReaderFrom 接口,复制操作也就会使用它来实现。

    ReadAtLeast 和 ReadFull 函数

    func ReadAtLeast(r Reader, buf []byte, min int) (n int, err error)
    

    ReadAtLeast 将 r 读取到 buf 中,直到读了最少 min 个字节为止。它返回复制的字节数,如果读取的字节较少,还会返回一个错误。若没有读取到字节,错误就只是 EOF。如果一个 EOF 发生在读取了少于 min 个字节之后,ReadAtLeast 就会返回 ErrUnexpectedEOF。若 min 大于 buf 的长度,ReadAtLeast 就会返回 ErrShortBuffer。对于返回值,当且仅当 err == nil 时,才有 n >= min。

    func ReadFull(r Reader, buf []byte) (n int, err error)
    

    ReadFull 精确地从 r 中将 len(buf) 个字节读取到 buf 中。它返回复制的字节数,如果读取的字节较少,还会返回一个错误。若没有读取到字节,错误就只是 EOF。如果一个 EOF 发生在读取了一些但不是所有的字节后,ReadFull 就会返回 ErrUnexpectedEOF。对于返回值,当且仅当 err == nil 时,才有 n == len(buf)。

    WriteString 函数

    func WriteString(w Writer, s string) (n int, err error)
    

    MultiReader 和 MultiWriter 函数

    这两个函数的定义分别是:

    func MultiReader(readers ...Reader) Reader
    func MultiWriter(writers ...Writer) Writer
    

    它们接收多个 Reader 或 Writer,返回一个 Reader 或 Writer。我们可以猜想到这两个函数就是操作多个 Reader 或 Writer 就像操作一个。

    TeeReader函数

    func TeeReader(r Reader, w Writer) Reader
    
  • 相关阅读:
    C#校验算法列举
    SuperSocket1.6电子书离线版
    C#检测系统是否激活[转自StackOverFlow]
    WSMBT Modbus & WSMBS Modbus 控件及注册机
    AU3获取系统激活信息
    JavaScript跨浏览器事件处理
    OAuth2的学习小结
    R学习日记——分解时间序列(季节性数据)
    R学习日记——分解时间序列(非季节性数据)
    Java内存分配原理
  • 原文地址:https://www.cnblogs.com/snowInPluto/p/7049989.html
Copyright © 2020-2023  润新知