diff options
| author | Tim Cooper <tim.cooper@layeh.com> | 2017-11-14 21:54:06 -0400 |
|---|---|---|
| committer | Brad Fitzpatrick <bradfitz@golang.org> | 2017-11-15 02:35:09 +0000 |
| commit | f4f6018d382f7360114d376f70b5d220d4f10716 (patch) | |
| tree | dfe6b07039588bd23ddb46a5aeb2960c1a9aba70 /src/encoding | |
| parent | 8cdd999bf54f5fae0acbf4a6d5a3911e4692ca28 (diff) | |
| download | go-f4f6018d382f7360114d376f70b5d220d4f10716.tar.xz | |
encoding/pem: add Encode, EncodeToMemory docs
Included in a warning that EncodeToMemory may return an incomplete PEM
encoded structure if invalid headers are supplied. Example:
pem.EncodeToMemory(&pem.Block{
Headers: map[string]string{
"a": "test1",
"b:c": "test2",
},
})
Returns:
-----BEGIN -----
a: test1
Change-Id: Ia9cf0202f985e3cf210aabb6f07667e581ff081f
Reviewed-on: https://go-review.googlesource.com/77790
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Diffstat (limited to 'src/encoding')
| -rw-r--r-- | src/encoding/pem/pem.go | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/encoding/pem/pem.go b/src/encoding/pem/pem.go index 887647b570..5cf90e7575 100644 --- a/src/encoding/pem/pem.go +++ b/src/encoding/pem/pem.go @@ -252,6 +252,7 @@ func writeHeader(out io.Writer, k, v string) error { return err } +// Encode writes the Block b to out. func Encode(out io.Writer, b *Block) error { if _, err := out.Write(pemStart[1:]); err != nil { return err @@ -310,6 +311,10 @@ func Encode(out io.Writer, b *Block) error { return err } +// EncodeToMemory returns the Block b. +// +// EncodeToMemory will return an incomplete PEM encoded structure if an invalid block is given. +// To catch errors, Blocks with user-supplied headers should use Encode. func EncodeToMemory(b *Block) []byte { var buf bytes.Buffer Encode(&buf, b) |