Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 16209] ファイルの概要

このコミットは、Go言語の標準ライブラリのAPI定義ファイルである api/next.txt を更新し、io パッケージに新しいエラー変数 io.ErrNoProgress を追加するものです。これは、Goの将来のリリースで導入されるAPI変更を追跡し、新しい機能や振る舞いを文書化するプロセスの一部です。

コミット

  • コミットハッシュ: c546e9d2c22f8d6149bc8050a94eb0a221553d3e5
  • 作者: Brad Fitzpatrick bradfitz@golang.org
  • コミット日時: 2013年4月20日 土曜日 17:20:58 -0700
  • コミットメッセージ: 
    api: update next.txt; add io.ErrNoProgress

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/8887043

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/c546e9d2c22f8d6149bc8050a94eb0a22153d3e5

元コミット内容

api: update next.txt; add io.ErrNoProgress

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/8887043

変更の背景

この変更の主な背景は、Go言語の標準ライブラリにおけるAPIの進化と、io パッケージにおける特定のシナリオでのエラーハンドリングの改善です。api/next.txt は、Goの次期リリースで導入される予定のAPI変更を記録するための重要なファイルです。このファイルに io.ErrNoProgress が追加されたということは、io パッケージ内の何らかの操作において、「進行がない」状態を明示的に示す新しいエラーが必要とされたことを意味します。

具体的には、io.Reader や io.Writer のようなインターフェースを実装する際に、呼び出しが成功したにもかかわらず、期待されるデータの読み書きが全く進まない（例えば、0バイトしか読み書きできない）状況が発生する可能性があります。このような状況は、デッドロックや無限ループにつながる可能性があり、アプリケーションの堅牢性を損なう原因となります。io.ErrNoProgress の導入は、このような特定の「進行なし」の状態を明確に区別し、開発者が適切に処理できるようにするためのものです。

前提知識の解説

api/next.txt と Go APIの安定性

Go言語は、後方互換性を非常に重視しており、既存のコードが新しいGoのバージョンでも動作し続けることを保証しています。この互換性を維持するために、Goの開発チームはAPIの変更を厳密に管理しています。api/next.txt は、Goの次期メジャーリリースで公開される予定のAPI変更（新しい関数、型、変数など）を事前に記録するためのテキストファイルです。

このファイルは、GoのAPIチェッカーによって利用され、Goのソースコードに対する変更がAPIの互換性を損なわないかを確認するために使用されます。新しいAPI要素が追加される際、まずこの api/next.txt にその情報が追記され、その後に実際のコード変更が行われます。これにより、APIの変更が意図的かつ計画的に行われ、開発者コミュニティに透明性を提供します。

io パッケージと io.Reader/io.Writer インターフェース

io パッケージは、Go言語におけるI/Oプリミティブを提供します。これは、データの読み書きに関する基本的なインターフェースと関数を含んでいます。

  • io.Reader インターフェース:

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

    Read メソッドは、データを p に読み込み、読み込んだバイト数 n とエラー err を返します。n が0で err が nil でない場合、エラーが発生したことを意味します。n が0で err が nil の場合、それは Read がブロックしたが、まだデータが利用可能でないことを意味します。

  • io.Writer インターフェース:

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

    Write メソッドは、p からデータを書き込み、書き込んだバイト数 n とエラー err を返します。

これらのインターフェースは、ファイル、ネットワーク接続、メモリバッファなど、さまざまなI/Oソースとシンクに対して統一されたアクセスを提供します。

Goにおけるエラーハンドリング

Go言語では、エラーは多値戻り値の最後の要素として返される慣習があります。通常、nil はエラーがないことを意味し、非 nil の error インターフェースの値はエラーが発生したことを示します。io パッケージには、io.EOF（ファイルの終端に達したことを示す）や io.ErrUnexpectedEOF（予期せぬファイルの終端）など、いくつかの標準的なエラーが定義されています。

技術的詳細

io.ErrNoProgress は、io パッケージに新しく追加されたエラー変数です。このエラーは、io.Reader や io.Writer の操作において、呼び出し自体は成功したものの、実際に読み書きされたバイト数が0であり、かつエラーも発生していないという、特定の「進行がない」状態を示すために導入されました。

このエラーがなぜ重要なのかを理解するために、io.Copy のような関数を考えてみましょう。io.Copy は io.Reader から io.Writer へデータをコピーしますが、内部的には Reader.Read と Writer.Write を繰り返し呼び出します。もし Read や Write の呼び出しが常に0バイトを返し、かつエラーも返さない場合、io.Copy は無限ループに陥る可能性があります。これは、特にネットワークI/OやパイプのようなブロックするI/O操作で発生しうる問題です。

io.ErrNoProgress の導入により、このような状況を明示的に検出できるようになります。例えば、io.Reader の実装が、特定の条件下で0バイトを返し、かつ nil エラーを返す場合、その実装は io.ErrNoProgress を返すように変更される可能性があります。これにより、io.Copy のような高レベルのI/O関数が、無限ループに陥ることなく、この「進行なし」の状態を検出し、適切にエラーを返すことができるようになります。

このエラーは、特にカスタムの io.Reader や io.Writer を実装する際に、その振る舞いをより正確に表現し、利用側がより堅牢なコードを書くための手がかりとなります。

コアとなるコードの変更箇所

このコミットによるコードの変更は、api/next.txt ファイルへの1行の追加のみです。

--- a/api/next.txt
+++ b/api/next.txt
@@ -122,6 +122,7 @@ pkg go/printer, type Config struct, Indent int
 pkg image, const YCbCrSubsampleRatio440 YCbCrSubsampleRatio
 pkg io, type ByteWriter interface { WriteByte }\n pkg io, type ByteWriter interface, WriteByte(uint8) error
+pkg io, var ErrNoProgress error
 pkg log/syslog (darwin-386), const LOG_AUTH Priority
 pkg log/syslog (darwin-386), const LOG_AUTHPRIV Priority
 pkg log/syslog (darwin-386), const LOG_CRON Priority

具体的には、+pkg io, var ErrNoProgress error の行が追加されています。

コアとなるコードの解説

追加された +pkg io, var ErrNoProgress error の行は、Goの次期リリースで io パッケージに ErrNoProgress という名前の error 型の変数が追加されることを示しています。

api/next.txt は、GoのAPI互換性チェックツールが使用するファイルであり、このファイルにエントリが追加されることで、Goの標準ライブラリに新しい公開API要素が導入されることが公式に宣言されます。

この行が意味することは以下の通りです。

  1. pkg io: この新しいAPI要素が io パッケージに属することを示します。
  2. var ErrNoProgress error: ErrNoProgress という名前の変数が追加され、その型が組み込みの error インターフェースであることを示します。これは、io.EOF のように、特定の状況を示すための事前定義されたエラー値として利用されることを意味します。

この変更自体は、実際のGoのソースコード（例: src/io/io.go）に var ErrNoProgress = errors.New("io: no progress") のような定義が追加されることを前提としています。api/next.txt への追加は、そのAPIがGoの将来のバージョンで利用可能になることを示す最初のステップです。

関連リンク

  • Go CL 8887043: https://golang.org/cl/8887043 (このコミットに対応するGoのコードレビューシステム上のチェンジリスト)

参考にした情報源リンク