Merge pull request #245 from devlights/add-ioutil-nopcloser-example-#241

Add ioutil.NopCloser example

Author: devlights

examples/basic/examples.go

@@ -17,6 +17,7 @@ import (
 	"github.com/devlights/try-golang/examples/basic/helloworld"
 	"github.com/devlights/try-golang/examples/basic/ifs"
 	"github.com/devlights/try-golang/examples/basic/imports"
+	"github.com/devlights/try-golang/examples/basic/iointerfaces"
 	"github.com/devlights/try-golang/examples/basic/literals"
 	"github.com/devlights/try-golang/examples/basic/logging"
 	"github.com/devlights/try-golang/examples/basic/maps"
@@ -68,6 +69,7 @@ func (r *register) Regist(m mappings.ExampleMapping) {
 	helloworld.NewRegister().Regist(m)
 	ifs.NewRegister().Regist(m)
 	imports.NewRegister().Regist(m)
+	iointerfaces.NewRegister().Regist(m)
 	literals.NewRegister().Regist(m)
 	logging.NewRegister().Regist(m)
 	maps.NewRegister().Regist(m)

examples/basic/iointerfaces/doc.go

@@ -0,0 +1,4 @@
+/*
+Package iointerfaces -- ioパッケージ配下やそれに関わるインターフェースについてのサンプルが配置されています.
+*/
+package iointerfaces

examples/basic/iointerfaces/examples.go

@@ -0,0 +1,19 @@
+package iointerfaces
+
+import (
+	"github.com/devlights/try-golang/mappings"
+)
+
+type (
+	register struct{}
+)
+
+// NewRegister -- このパッケージ用のサンプルを登録する mappings.Register を生成します。
+func NewRegister() mappings.Register {
+	return new(register)
+}
+
+// Regist -- 登録します.
+func (r *register) Regist(m mappings.ExampleMapping) {
+	m["iointerfaces_nopcloser"] = UsingNopCloser
+}

examples/basic/iointerfaces/using_nopcloser.go

@@ -0,0 +1,65 @@
+package iointerfaces
+
+import (
+	"bytes"
+	"io"
+	"io/ioutil"
+
+	"github.com/devlights/gomy/output"
+)
+
+type (
+	// _readcloserimpl -- サンプル用 io.ReadCloser の実装
+	_readcloserimpl struct {
+		reader io.Reader
+	}
+)
+
+// Impl check
+var _ io.ReadCloser = (*_readcloserimpl)(nil)
+
+// Impl -- io.Reader#Read
+func (r *_readcloserimpl) Read(p []byte) (int, error) {
+	return r.reader.Read(p)
+}
+
+// Impl -- io.Closer#Close
+func (r *_readcloserimpl) Close() error {
+	output.Stdoutl("[_readcloserimpl]", "Close() called")
+	return nil
+}
+
+// UsingNopCloser -- ioutil.NopCloser についてのサンプルです.
+//
+// REFERENCES:
+//   - https://golang.org/pkg/io/ioutil/#NopCloser
+func UsingNopCloser() error {
+	// ------------------------------------------------------------
+	// ioutil.NopCloser は、Closeが呼ばれても何もしない
+	// io.ReadCloser を返す.
+	//
+	// 処理内部で Close メソッドが呼ばれてしまうが
+	// そのタイミングで Close はしてほしくない場合などで利用できる.
+	// ------------------------------------------------------------
+	var (
+		r         = bytes.NewReader([]byte("hello"))
+		reader    = &_readcloserimpl{reader: r}
+		nopcloser = ioutil.NopCloser(reader)
+	)
+
+	// NopCloser は、Close のみ何もしないインターフェースなので
+	// Readは問題なく実行できる
+	buf := make([]byte, 3)
+	_, _ = nopcloser.Read(buf)
+	output.Stdoutl("[nopcloser.Read]", buf)
+
+	// Close を呼び出しても何も起きない
+	output.Stdoutl(">>", "before NopCloser.Close")
+	_ = nopcloser.Close()
+	output.Stdoutl(">>", "after  NopCloser.Close")
+
+	// 実際の io.Closer の Close を呼び出し
+	_ = reader.Close()
+
+	return nil
+}