-
Notifications
You must be signed in to change notification settings - Fork 9.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add FileReader and FileBufReader utilities
The FileReader interface is the wrapper of io.Reader. It provides the fs.FileInfo as well. The FileBufReader struct is the wrapper of bufio.Reader, it also provides fs.FileInfo. Signed-off-by: Benjamin Wang <wachao@vmware.com>
- Loading branch information
Showing
2 changed files
with
104 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
// Copyright 2022 The etcd Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package fileutil | ||
|
||
import ( | ||
"bufio" | ||
"io" | ||
"io/fs" | ||
"os" | ||
) | ||
|
||
// FileReader is a wrapper of io.Reader. It also provides file info. | ||
type FileReader interface { | ||
io.Reader | ||
FileInfo() (fs.FileInfo, error) | ||
} | ||
|
||
type fileReader struct { | ||
*os.File | ||
} | ||
|
||
func NewFileReader(f *os.File) FileReader { | ||
return &fileReader{f} | ||
} | ||
|
||
func (fr *fileReader) FileInfo() (fs.FileInfo, error) { | ||
return fr.Stat() | ||
} | ||
|
||
// FileBufReader is a wrapper of bufio.Reader. It also provides file info. | ||
type FileBufReader struct { | ||
*bufio.Reader | ||
fi fs.FileInfo | ||
} | ||
|
||
func NewFileBufReader(fr FileReader) *FileBufReader { | ||
bufReader := bufio.NewReader(fr) | ||
fi, err := fr.FileInfo() | ||
if err != nil { | ||
// This should never happen. | ||
panic(err) | ||
} | ||
return &FileBufReader{bufReader, fi} | ||
} | ||
|
||
func (fbr *FileBufReader) FileInfo() fs.FileInfo { | ||
return fbr.fi | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
// Copyright 2022 The etcd Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package fileutil | ||
|
||
import ( | ||
"os" | ||
"strings" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
func TestFileBufReader(t *testing.T) { | ||
f, err := os.CreateTemp(t.TempDir(), "wal") | ||
if err != nil { | ||
t.Errorf("Unexpected error: %v", err) | ||
} | ||
fi, err := f.Stat() | ||
if err != nil { | ||
t.Errorf("Unexpected error: %v", err) | ||
} | ||
|
||
fbr := NewFileBufReader(NewFileReader(f)) | ||
|
||
if !strings.HasPrefix(fbr.FileInfo().Name(), "wal") { | ||
t.Errorf("Unexpected file name: %s", fbr.FileInfo().Name()) | ||
} | ||
assert.Equal(t, fi.Size(), fbr.FileInfo().Size()) | ||
assert.Equal(t, fi.IsDir(), fbr.FileInfo().IsDir()) | ||
assert.Equal(t, fi.Mode(), fbr.FileInfo().Mode()) | ||
assert.Equal(t, fi.ModTime(), fbr.FileInfo().ModTime()) | ||
} |