Go Package io: Difference between revisions
(→Writer) |
|||
| Line 51: | Line 51: | ||
Files opened with <code>[[Go_Package_os#os.Create.28.29|os.Create()]]</code> implement <code>io.Writer</code>. | Files opened with <code>[[Go_Package_os#os.Create.28.29|os.Create()]]</code> implement <code>io.Writer</code>. | ||
<code>bytes.Buffer</code> implements <code>io.Writer</code> so a <code>bytes.Buffer</code> instance can be used to be written into and get the string representation. The following example dumps the content of a <code>net/http.Request</code> into a string, identically with how it will be sent over the wire: | |||
<syntaxhighlight lang='go'> | |||
var r = &http.Request{...} | |||
b := &bytes.Buffer{} | |||
if err := r.Write(b); err != nil { ... } | |||
s := b.String() | |||
</syntaxhighlight> | |||
=<tt>Closer</tt>= | =<tt>Closer</tt>= | ||
Revision as of 02:05, 21 July 2024
External
Internal
Overview
The io package consists of a few functions, but mostly interfaces used by other packages.
io.EOF
The error returned by I/O operations that encounter the end of file. It can be tested with:
_, err := ...
if errors.Is(err, io.EOF) {
// is EOF
...
}
Reader
An interface that exposes Read().
Readers can be used to unmarshall JSON into structs as shown here:
Files opened with os.Create() implement io.Reader.
Wrapping a []byte into a Reader
A []byte can be wrapped into a Reader with:
import "bytes"
bs := []byte("something")
r := bytes.NewReader(bs)
Getting a Reader from a string
s := "some string"
reader := strings.NewReader(s)
Writer
Files opened with os.Create() implement io.Writer.
bytes.Buffer implements io.Writer so a bytes.Buffer instance can be used to be written into and get the string representation. The following example dumps the content of a net/http.Request into a string, identically with how it will be sent over the wire:
var r = &http.Request{...}
b := &bytes.Buffer{}
if err := r.Write(b); err != nil { ... }
s := b.String()
Closer
Files opened with os.Create() implement io.Closer.
ReadCloser
An interface that exposes basic Read() and Close() methods. The http.Request body is a ReadCloser. See Reader.