github.com/gohugoio/hugo@v0.88.1/common/hugio/readers.go (about)

     1  // Copyright 2019 The Hugo Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  // http://www.apache.org/licenses/LICENSE-2.0
     7  //
     8  // Unless required by applicable law or agreed to in writing, software
     9  // distributed under the License is distributed on an "AS IS" BASIS,
    10  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package hugio
    15  
    16  import (
    17  	"io"
    18  	"strings"
    19  )
    20  
    21  // ReadSeeker wraps io.Reader and io.Seeker.
    22  type ReadSeeker interface {
    23  	io.Reader
    24  	io.Seeker
    25  }
    26  
    27  // ReadSeekCloser is implemented by afero.File. We use this as the common type for
    28  // content in Resource objects, even for strings.
    29  type ReadSeekCloser interface {
    30  	ReadSeeker
    31  	io.Closer
    32  }
    33  
    34  // ReadSeekerNoOpCloser implements ReadSeekCloser by doing nothing in Close.
    35  // TODO(bep) rename this and similar to ReadSeekerNopCloser, naming used in stdlib, which kind of makes sense.
    36  type ReadSeekerNoOpCloser struct {
    37  	ReadSeeker
    38  }
    39  
    40  // Close does nothing.
    41  func (r ReadSeekerNoOpCloser) Close() error {
    42  	return nil
    43  }
    44  
    45  // NewReadSeekerNoOpCloser creates a new ReadSeekerNoOpCloser with the given ReadSeeker.
    46  func NewReadSeekerNoOpCloser(r ReadSeeker) ReadSeekerNoOpCloser {
    47  	return ReadSeekerNoOpCloser{r}
    48  }
    49  
    50  // NewReadSeekerNoOpCloserFromString uses strings.NewReader to create a new ReadSeekerNoOpCloser
    51  // from the given string.
    52  func NewReadSeekerNoOpCloserFromString(content string) ReadSeekerNoOpCloser {
    53  	return ReadSeekerNoOpCloser{strings.NewReader(content)}
    54  }