Skip to content

class IO::Digest
inherits IO

Wraps an IO by calculating a specified Digest on read or write operations.

Example

require "digest"

underlying_io = IO::Memory.new("foo")
io = IO::Digest.new(underlying_io, Digest::SHA256.new)
buffer = Bytes.new(256)
io.read(buffer)
io.final.hexstring # => "2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"

Class methods

.new(io : IO, digest_algorithm : ::Digest, mode = DigestMode::Read)

View source

Methods

#close(*args, **options)

View source

#close

View source

#closed?(*args, **options)

View source

#closed?

View source

#digest_algorithm : ::Digest

View source

#final

View source

#final(*args, **options)

View source

#flush(*args, **options)

View source

#flush

View source

#io : IO

View source

#peek

View source

#peek(*args, **options)

View source

#read(slice : Bytes)

Reads at most slice.size bytes from this IO into slice. Returns the number of bytes read, which is 0 if and only if there is no more data to read (so checking for 0 is the way to detect end of file).

io = IO::Memory.new "hello"
slice = Bytes.new(4)
io.read(slice) # => 4
slice          # => Bytes[104, 101, 108, 108]
io.read(slice) # => 1
slice          # => Bytes[111, 101, 108, 108]
io.read(slice) # => 0
View source

#rewind(*args, **options)

View source

#rewind

View source

#tty?(*args, **options)

View source

#tty?

View source

#write(slice : Bytes) : Nil

Writes the contents of slice into this IO.

io = IO::Memory.new
slice = Bytes.new(4) { |i| ('a'.ord + i).to_u8 }
io.write(slice)
io.to_s # => "abcd"
View source