io_util

func CopyReaderToWriterAt ¶ added in v1.0.2

func CopyReaderToWriterAt(r io.Reader, w io.WriterAt, offset int64, nonBuffer bool) (written int64, err error)

CopyReaderToWriterAt 将 r 中数据写入 w，直到 r 读取返回 io.EOF 结束读取。

r：要读取数据的流。

w：数据要写入的流。

offset：从 w 指定位置开始写入。

nonBuffer：读取数据时，每次都分配新的内存。

written：总计 w 写入数据的大小。

err：异常信息。

注意：offset 为负数将触发恐慌。

func NewMultiReadCloserToReader ¶

func NewMultiReadCloserToReader(ctx context.Context, rc ...io.ReadCloser) (
	r io.Reader, add func(rc io.ReadCloser) error, endAdd func())

NewMultiReadCloserToReader 依次将 rc 中的数据转到 r 中读出。每一个 rc 读取数据直到 io.EOF 后调用关闭。

ctx：上下文。如果终止了，r 将返回 ctx.Err()。

rc：要读取数据的流。可以为空。

r：合并所有 rc 数据的流。

add：添加 rc，返回错误表明读取 rc 发生错误，将不再读取剩余的 rc，且所有添加进去的 rc 都会调用关闭。可以安全的添加空 rc。

endAdd：调用后表明不会再有 rc 添加，当所有 rc 数据读完了时，r 将返回 io.EOF。

注意：所有添加进去的 ReadCloser 都会被关闭，即使发生了错误。除非 r 没有读取直到 io.EOF。

注意：请务必调用 endAdd 以便 r 能读取完毕返回 io.EOF。

注意：在 endAdd 后再 add rc 将会触发恐慌返回 ErrAddAfterEnd，且该 rc 不会被关闭。

package main

import (
	"context"
	"io"

	iu "gitee.com/ivfzhou/io-util"
)

func main() {
	ctx := context.Background()
	var rc1 io.ReadCloser
	var rc2 io.ReadCloser
	r, add, endAdd := iu.NewMultiReadCloserToReader(ctx, rc1, rc2)

	// 继续添加 Reader。
	go func() {
		var rc3 io.ReadCloser
		var rc4 io.ReadCloser
		err := add(rc3)
		err = add(rc4)
		_ = err
		// 处理 err。

		// 添加完所有 Reader 后调用。
		endAdd()
	}()

	// 将所有的 Reader 数据按顺序读出。
	bs, err := io.ReadAll(r)
	_, _ = bs, err
}

Output:

func NewMultiReadCloserToWriter ¶

func NewMultiReadCloserToWriter(ctx context.Context, writer func(offset int, p []byte)) (
	send func(readSize, offset int, reader io.ReadCloser), wait func() error)

NewMultiReadCloserToWriter 依次从 reader 读出数据并写入 writer 中，并关闭 reader。

ctx：上下文，如果上下文终止了，将停止读取并返回 ctx.Err()。

writer：从 reader 中读取的数据将写入它。

send：提交 reader，读取 readSize 大小数据。如果读取不到足够的数据将返回错误。如果 reader 是空将触发恐慌。

wait：等待所有 reader 读取完毕。调用 wait 后不可再调用 send，否则触发恐慌。

func NewMultiReadCloserToWriterAt ¶ added in v1.0.2

func NewMultiReadCloserToWriterAt(ctx context.Context, wa io.WriterAt) (
	send func(rc io.ReadCloser, offset int64) error, wait func(fastExit bool) error)

NewMultiReadCloserToWriterAt 将 rc 数据读取并写入 wa。

ctx：上下文，如果终止了将终止流读写，并返回 ctx.Err()。

wa：从 rc 中读取的数据将写入它。

send：添加需要读取的数据流 rc。offset 表示从 wa 指定位置开始读取。所有 rc 都将关闭。若 rc 是空，将触发恐慌。

wait：添加完所有 rc 后调用，等待所有数据处理完毕。fastExit 表示当发生错误时，立刻返回该错误。

注意：若 wa 是空，将触发恐慌。

func NewWriteAtToReader2 ¶ added in v1.0.2

func NewWriteAtToReader2() (wc WriteAtCloser, rc ReadCloser)

NewWriteAtToReader2 同 NewWriteAtToReader 类似，但是 wc 会持有写入的字节，而不是复制一份。然后从 rc 处读出这些字节。

注意：对 wc 写入的字节变量的底层字节数组的修改，可能会影响到 rc 读取的字节也跟着被修改。因为它们是同一个底层字节数组。

package main

import (
	"errors"

	iu "gitee.com/ivfzhou/io-util"
)

func main() {
	wc, rc := iu.NewWriteAtToReader2()

	// 读取完后关闭流。
	defer rc.Close()

	// 在另一个协程中写入数据。
	go func() {
		// 可并发写入。
		n, err := wc.WriteAt([]byte("hello world"), 0)

		// 处理 err 和 n。
		_, _ = n, err

		// 写入完毕后关闭流。
		wc.Close()

		// 如果处理过程中发生错误，可将错误信息传递给 rc。
		wc.CloseByError(errors.New("some error"))
	}()

	// 读取出 wc 中写入的数据。
	bs, err := iu.ReadAll(rc)

	// 处理 bs 和 err。
	_, _ = bs, err
}

Output:

func ReadAll ¶ added in v1.0.2

func ReadAll(r Reader) ([]byte, error)

ReadAll 读取出所有字节，直到 r 返回 io.EOF。如果全部读出，没有错误，则 error 返回 nil，EOF 被剔除。

注意：如果 r 是空，将触发恐慌。

func ToReader ¶ added in v1.2.0

func ToReader(r ReadCloser) io.ReadCloser

ToReader 转换成 io.ReadCloser 对象。

func WrapError ¶ added in v1.0.2

func WrapError(err error) error

WrapError 包裹错误信息。

func WriteAtAll ¶ added in v1.2.0

func WriteAtAll(wa io.WriterAt, offset int64, p []byte) (written int64, err error)

WriteAtAll 将数据全部写入 wa。