github.com/shogo82148/std@v1.22.1-0.20240327122250-4e474527810c/runtime/coverage/apis.go (about)

     1  // Copyright 2022 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  package coverage
     6  
     7  import (
     8  	"github.com/shogo82148/std/io"
     9  )
    10  
    11  // WriteMetaDirは現在実行中のプログラムのカバレッジのメタデータファイルを'dir'で指定されたディレクトリに書き込みます。操作が正常に完了できない場合にはエラーが返されます（たとえば、現在実行中のプログラムが"-cover"でビルドされていない場合、またはディレクトリが存在しない場合など）。
    12  func WriteMetaDir(dir string) error
    13  
    14  // WriteMetaは、現在実行中のプログラムのメタデータコンテンツ（通常はメタデータファイルに出力されるペイロード）をライター 'w'に書き込みます。操作が正常に完了できない場合（例えば、現在実行中のプログラムが "-cover" でビルドされていない場合や書き込みに失敗した場合など）、エラーが返されます。
    15  func WriteMeta(w io.Writer) error
    16  
    17  // WriteCountersDirは、現在実行中のプログラムのカバレッジカウンターデータファイルを'dir'で指定されたディレクトリに書き込みます。操作を正常に完了できない場合（たとえば、現在実行中のプログラムが'-cover'でビルドされていない場合や、ディレクトリが存在しない場合など）、エラーが返されます。書き込まれるカウンターデータは、呼び出し時のスナップショットとなります。
    18  func WriteCountersDir(dir string) error
    19  
    20  // WriteCountersは現在実行中のプログラムのカバレッジカウンターデータの内容をライター'w'に書き込みます。現在実行中のプログラムが"-cover"でビルドされていない場合や書き込みが失敗した場合など、操作が正常に完了できない場合はエラーが返されます。書き込まれるカウンターデータは、呼び出し時のスナップショットになります。
    21  func WriteCounters(w io.Writer) error
    22  
    23  // ClearCountersは現在実行中のプログラム内のカバレッジカウンタ変数をクリア/リセットします。
    24  // "-cover"フラグでビルドされたプログラムではない場合、エラーが返されます。
    25  // カウンタのクリアは、アトミックカウンタモードを使用しないプログラムに対してもサポートされていません
    26  // (詳細なコメントについては、下記を参照してください）。
    27  func ClearCounters() error