xio

Documentation

Overview

Package xio extends the Go standard library package io by providing additional I/O primitives.

Index

• func DrainClose(rc io.ReadCloser) error
• func DuplicateReadCloser(rc io.ReadCloser) (rc1, rc2 io.ReadCloser, err error)
• func DuplicateReader(r io.Reader) (r1, r2 io.Reader, err error)

Examples

• DrainClose
• DuplicateReadCloser
• DuplicateReader

Functions

func DrainClose

func DrainClose(rc io.ReadCloser) error

DrainClose discards the entire ReadCloser and closes it.

Example

package main

import (
	"fmt"
	"io"
	"log"
	"strings"

	"github.com/jlourenc/xgo/xio"
)

func main() {
	rc := io.NopCloser(strings.NewReader("message"))

	if err := xio.DrainClose(rc); err != nil {
		log.Fatalf("Failed to drain and close ReadCloser: %v", err)
	}

	b, _ := io.ReadAll(rc)

	fmt.Printf("%s\n", b)
}

func DuplicateReadCloser

func DuplicateReadCloser(rc io.ReadCloser) (rc1, rc2 io.ReadCloser, err error)

DuplicateReadCloser reads all of b to memory and then returns two equivalent ReadClosers yielding the same bytes.

It returns an error if the initial slurp of all bytes fails. It does not attempt to make the returned ReadClosers have identical error-matching behavior.

Example

package main

import (
	"fmt"
	"io"
	"log"
	"strings"

	"github.com/jlourenc/xgo/xio"
)

func main() {
	rc := io.NopCloser(strings.NewReader("message"))

	rc1, rc2, err := xio.DuplicateReadCloser(rc)
	if err != nil {
		log.Fatalf("Failed to duplicate Reader: %v", err)
	}
	defer rc1.Close()
	defer rc2.Close()

	b1, _ := io.ReadAll(rc1)
	b2, _ := io.ReadAll(rc2)

	fmt.Printf("%s\n", b1)
	fmt.Printf("%s\n", b2)
}

Output:

message
message

func DuplicateReader

func DuplicateReader(r io.Reader) (r1, r2 io.Reader, err error)

DuplicateReader reads all of b to memmory and then returns two equivalent Readers yielding the same bytes.

It returns an error if the initial slurp of all bytes fails. It does not attempt to make the returned ReadClosers have identical error-matching behavior.

Example

package main

import (
	"fmt"
	"io"
	"log"
	"strings"

	"github.com/jlourenc/xgo/xio"
)

func main() {
	r := strings.NewReader("message")

	r1, r2, err := xio.DuplicateReader(r)
	if err != nil {
		log.Fatalf("Failed to duplicate Reader: %v", err)
	}

	b1, _ := io.ReadAll(r1)
	b2, _ := io.ReadAll(r2)

	fmt.Printf("%s\n", b1)
	fmt.Printf("%s\n", b2)
}

Output:

message
message