github.com/pietrocarrara/hugo@v0.47.1/resource/readers.go (about)

     1  // Copyright 2018 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 resource
    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  type ReadSeekerNoOpCloser struct {
    36  	ReadSeeker
    37  }
    38  
    39  // Close does nothing.
    40  func (r ReadSeekerNoOpCloser) Close() error {
    41  	return nil
    42  }
    43  
    44  // NewReadSeekerNoOpCloser creates a new ReadSeekerNoOpCloser with the given ReadSeeker.
    45  func NewReadSeekerNoOpCloser(r ReadSeeker) ReadSeekerNoOpCloser {
    46  	return ReadSeekerNoOpCloser{r}
    47  }
    48  
    49  // NewReadSeekerNoOpCloserFromString uses strings.NewReader to create a new ReadSeekerNoOpCloser
    50  // from the given string.
    51  func NewReadSeekerNoOpCloserFromString(content string) ReadSeekerNoOpCloser {
    52  	return ReadSeekerNoOpCloser{strings.NewReader(content)}
    53  }