aboutsummaryrefslogtreecommitdiff
path: root/src/io
diff options
context:
space:
mode:
authorGreg Poirier <greg.istehbest@gmail.com>2017-07-15 12:03:33 -0600
committerBrad Fitzpatrick <bradfitz@golang.org>2017-07-15 19:36:41 +0000
commit0a633c3bbef4764ab486a0cb0ba154c5db099eac (patch)
tree19f98cea158a8187cc98de51db3232c3563fdc2c /src/io
parent0593ad1e235d324d928fd045bb97098cb3bd1c66 (diff)
downloadgo-0a633c3bbef4764ab486a0cb0ba154c5db099eac.tar.xz
io: Add example to io.Seeker's Seek() method.
While there's an example for SectionReader.Seek, if someone is seeking documentation specifically about Seeker.Seek, they may not immediately find the SectionReader example. Offset and whence may not be entirely intuitive to new developers either, so include examples of both positive/negative offsets and SeekStart/SeekEnd. Change-Id: I5b7442ccf683d9706e9261c11bc0ea31a1ac21d4 Reviewed-on: https://go-review.googlesource.com/48873 Reviewed-by: Kevin Burke <kev@inburke.com> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
Diffstat (limited to 'src/io')
-rw-r--r--src/io/example_test.go22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/io/example_test.go b/src/io/example_test.go
index bf16de8fe2..af47853726 100644
--- a/src/io/example_test.go
+++ b/src/io/example_test.go
@@ -204,6 +204,28 @@ func ExampleSectionReader_Seek() {
// stream
}
+func ExampleSeeker_Seek() {
+ r := strings.NewReader("some io.Reader stream to be read\n")
+ if _, err := io.Copy(os.Stdout, r); err != nil {
+ log.Fatal(err)
+ }
+
+ r.Seek(15, io.SeekStart)
+ if _, err := io.Copy(os.Stdout, r); err != nil {
+ log.Fatal(err)
+ }
+
+ r.Seek(-5, io.SeekEnd)
+ if _, err := io.Copy(os.Stdout, r); err != nil {
+ log.Fatal(err)
+ }
+
+ // Output:
+ // some io.Reader stream to be read
+ // stream to be read
+ // read
+}
+
func ExampleMultiWriter() {
r := strings.NewReader("some io.Reader stream to be read\n")