Merge pull request #18 from lmiq/seekstart

deprecate rewind in favor of seekstart

Author: lmiq

CHANGELOG.md

@@ -12,7 +12,7 @@ FortranFiles.jl Changelog
 
 Version 0.6.2-DEV
 -------------
-
+- ![INFO][badge-info] `seekstart` is used instead of `rewind` (which will be deprecated in future version).
 
 Version 0.6.1
 -------------

README.md

@@ -55,7 +55,7 @@ i, strings, zmatrix = read(f, Int32, (FString{20},10), (ComplexF64,10,10))
 read(f)
 
 # go back to the beginning of the file
-rewind(f)
+seekstart(f)
 ```
 
 Example usage for writing files:

docs/src/files.md

@@ -60,7 +60,7 @@ To test for EOF, use the standard Julia `eof` function.
 
 The following functions are provided to emulate certain Fortran I/O statements:
 ```@docs
-rewind
+seekstart
 ```
 
 

src/FortranFiles.jl

@@ -2,7 +2,7 @@ __precompile__()
 
 module FortranFiles
 
-    export FortranFile, rewind
+    export FortranFile
     export RECMRK4B, RECMRK8B
     export FString, trimstring, trimlen, trim
     export FortranFilesError

src/file.jl

@@ -76,8 +76,8 @@ end
 
 
 "Re-position a `FortranFile` at its beginning."
-rewind(f::FortranFile) = seek(f.io, 0)
-
+Base.seekstart(f::FortranFile) = seekstart(f.io)
+@deprecate rewind seekstart
 
 Base.close(f::FortranFile) = close(f.io)
 

test/runtests.jl

@@ -346,10 +346,13 @@ Sys.islinux() && @testset "Testing records with $(rectest.desc), $(botest.name)
         rewind(infile)
         data2 = freaddata(infile)
         @test data == data2
+        seekstart(infile)
+        data2 = freaddata(infile)
+        @test data == data2
     end
 
     @time @testset "Reading data with skipping" begin
-        rewind(infile)
+        seekstart(infile)
         skipdata(infile)
         close(infile)
     end