pkg/ioutils: deprecate NopWriteCloser

thaJeztah · thaJeztah · commit 8a2fd51c84e9 · 2025-01-10T14:37:48.000+01:00
It was only used internally, and has no external consumers; deprecate it to be removed in the next release. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 3faa170) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
diff --git a/container/stream/streams.go b/container/stream/streams.go
@@ -87,9 +87,15 @@ func (c *Config) NewInputPipes() {
 
 // NewNopInputPipe creates a new input pipe that will silently drop all messages in the input.
 func (c *Config) NewNopInputPipe() {
-	c.stdinPipe = ioutils.NopWriteCloser(io.Discard)
+	c.stdinPipe = &nopWriteCloser{io.Discard}
 }
 
+type nopWriteCloser struct {
+	io.Writer
+}
+
+func (w *nopWriteCloser) Close() error { return nil }
+
 // CloseStreams ensures that the configured streams are properly closed.
 func (c *Config) CloseStreams() error {
 	var errs []string
diff --git a/pkg/ioutils/writers.go b/pkg/ioutils/writers.go
@@ -21,6 +21,8 @@ type nopWriteCloser struct {
 func (w *nopWriteCloser) Close() error { return nil }
 
 // NopWriteCloser returns a nopWriteCloser.
+//
+// Deprecated: This function is no longer used and will be removed in the next release.
 func NopWriteCloser(w io.Writer) io.WriteCloser {
 	return &nopWriteCloser{w}
 }

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ type nopWriteCloser struct {`
`21`	`21`	`func (w *nopWriteCloser) Close() error { return nil }`
`22`	`22`
`23`	`23`	`// NopWriteCloser returns a nopWriteCloser.`
	`24`	`+//`
	`25`	`+// Deprecated: This function is no longer used and will be removed in the next release.`
`24`	`26`	`func NopWriteCloser(w io.Writer) io.WriteCloser {`
`25`	`27`	`return &nopWriteCloser{w}`
`26`	`28`	`}`