Improve readall() convenience function, add readstring()

Author: nalimilan

src/StringEncodings.jl

@@ -285,8 +285,24 @@ function read(s::StringDecoder, ::Type{UInt8})
     eof(s) ? throw(EOFError()) : s.outbuf[s.skip+=1]
 end
 
-function readall(filename::AbstractString, encoding::ASCIIString)
-    open(s -> readall(StringDecoder(s, encoding)), filename)
+
+## Convenience I/O functions
+if isdefined(Base, :readstring)
+    """
+        readstring(stream or filename, enc::ASCIIString)
+
+    Read the entire contents of an I/O stream or a file in encoding `enc` as a string.
+    """
+    Base.readstring(s::IO, enc::ASCIIString) = readstring(StringDecoder(s, enc))
+    Base.readstring(filename::AbstractString, enc::ASCIIString) = open(io->readstring(io, enc), filename)
+else # Compatibility with Julia 0.4
+    """
+        readall(stream or filename, enc::ASCIIString)
+
+    Read the entire contents of an I/O stream or a file in encoding `enc` as a string.
+    """
+    Base.readall(s::IO, enc::ASCIIString) = readall(StringDecoder(s, enc))
+    Base.readall(filename::AbstractString, enc::ASCIIString) = open(io->readall(io, enc), filename)
 end
 
 
@@ -330,6 +346,7 @@ function encode(s::AbstractString, enc::ASCIIString)
     takebuf_array(b)
 end
 
+
 ## Function to list supported encodings
 include("encodings.jl")
 

test/runtests.jl

@@ -127,6 +127,19 @@ catch err
         "Conversion from nonexistent_encoding to UTF-8 not supported by iconv implementation, check that specified encodings are correct"
 end
 
+if !isdefined(Base, :readstring)
+    readstring = readall
+end
+
+mktemp() do path, io
+    s = "a string \0チャネルパ\0ー\0トナーの選択 with embedded and trailing nuls\0"
+    write(io, encode(s, "ISO-2022-JP"))
+    close(io)
+
+    @test readstring(path, "ISO-2022-JP") == s
+    @test open(io->readstring(io, "ISO-2022-JP"), path) == s
+end
+
 encodings_list = encodings()
 @test "ASCII" in encodings_list
 @test "UTF-8" in encodings_list