1 // Copyright 2009 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.
13 // A Reader implements the io.Reader, io.ReaderAt, io.ByteReader, io.ByteScanner,
14 // io.RuneReader, io.RuneScanner, io.Seeker, and io.WriterTo interfaces by reading
16 // The zero value for Reader operates like a Reader of an empty string.
19 i
int64 // current reading index
20 prevRune
int // index of previous rune; or < 0
23 // Len returns the number of bytes of the unread portion of the
25 func (r
*Reader
) Len() int {
26 if r
.i
>= int64(len(r
.s
)) {
29 return int(int64(len(r
.s
)) - r
.i
)
32 // Size returns the original length of the underlying string.
33 // Size is the number of bytes available for reading via ReadAt.
34 // The returned value is always the same and is not affected by calls
35 // to any other method.
36 func (r
*Reader
) Size() int64 { return int64(len(r
.s
)) }
38 // Read implements the io.Reader interface.
39 func (r
*Reader
) Read(b
[]byte) (n
int, err error
) {
40 if r
.i
>= int64(len(r
.s
)) {
44 n
= copy(b
, r
.s
[r
.i
:])
49 // ReadAt implements the io.ReaderAt interface.
50 func (r
*Reader
) ReadAt(b
[]byte, off
int64) (n
int, err error
) {
51 // cannot modify state - see io.ReaderAt
53 return 0, errors
.New("strings.Reader.ReadAt: negative offset")
55 if off
>= int64(len(r
.s
)) {
58 n
= copy(b
, r
.s
[off
:])
65 // ReadByte implements the io.ByteReader interface.
66 func (r
*Reader
) ReadByte() (byte, error
) {
68 if r
.i
>= int64(len(r
.s
)) {
76 // UnreadByte implements the io.ByteScanner interface.
77 func (r
*Reader
) UnreadByte() error
{
79 return errors
.New("strings.Reader.UnreadByte: at beginning of string")
86 // ReadRune implements the io.RuneReader interface.
87 func (r
*Reader
) ReadRune() (ch rune
, size
int, err error
) {
88 if r
.i
>= int64(len(r
.s
)) {
93 if c
:= r
.s
[r
.i
]; c
< utf8
.RuneSelf
{
95 return rune(c
), 1, nil
97 ch
, size
= utf8
.DecodeRuneInString(r
.s
[r
.i
:])
102 // UnreadRune implements the io.RuneScanner interface.
103 func (r
*Reader
) UnreadRune() error
{
105 return errors
.New("strings.Reader.UnreadRune: at beginning of string")
108 return errors
.New("strings.Reader.UnreadRune: previous operation was not ReadRune")
110 r
.i
= int64(r
.prevRune
)
115 // Seek implements the io.Seeker interface.
116 func (r
*Reader
) Seek(offset
int64, whence
int) (int64, error
) {
125 abs
= int64(len(r
.s
)) + offset
127 return 0, errors
.New("strings.Reader.Seek: invalid whence")
130 return 0, errors
.New("strings.Reader.Seek: negative position")
136 // WriteTo implements the io.WriterTo interface.
137 func (r
*Reader
) WriteTo(w io
.Writer
) (n
int64, err error
) {
139 if r
.i
>= int64(len(r
.s
)) {
143 m
, err
:= io
.WriteString(w
, s
)
145 panic("strings.Reader.WriteTo: invalid WriteString count")
149 if m
!= len(s
) && err
== nil {
150 err
= io
.ErrShortWrite
155 // Reset resets the Reader to be reading from s.
156 func (r
*Reader
) Reset(s
string) { *r
= Reader
{s
, 0, -1} }
158 // NewReader returns a new Reader reading from s.
159 // It is similar to bytes.NewBufferString but more efficient and read-only.
160 func NewReader(s
string) *Reader
{ return &Reader
{s
, 0, -1} }