class Gem::Package::DigestIO - Documentation for Ruby 4.0
Description: class Gem::Package::DigestIO: IO wrapper that creates digests of contents written to the IO it wraps.
Keywords: ruby,class,Gem::Package::DigestIO

🔍

No recent searches

# class Gem::Package::DigestIO

`IO` wrapper that creates digests of contents written to the `IO` it wraps.

### Attributes

digests [R]

Collected digests for wrapped writes.

    {
      'SHA1'   => #<OpenSSL::Digest: [...]>,
      'SHA512' => #<OpenSSL::Digest: [...]>,
    }

### Public Class Methods

new (io, digests)
Source

    # File lib/rubygems/package/digest_io.rb, line 46
    def initialize(io, digests)
      @io = io
      @digests = digests
    end

Creates a new `DigestIO` instance. Using `::wrap` is recommended, see the `::wrap` documentation for documentation of `io` and `digests`.

wrap (io, digests) { |digest_io| ... }
Source

    # File lib/rubygems/package/digest_io.rb, line 34
    def self.wrap(io, digests)
      digest_io = new io, digests

      yield digest_io

      digests
    end

Wraps `io` and updates digest for each of the digest algorithms in the `digests` `Hash`. Returns the digests hash. Example:

    io = StringIO.new
    digests = {
      'SHA1'   => OpenSSL::Digest.new('SHA1'),
      'SHA512' => OpenSSL::Digest.new('SHA512'),
    }

    Gem::Package::DigestIO.wrap io, digests do |digest_io|
      digest_io.write "hello"
    end

    digests['SHA1'].hexdigest   #=> "aaf4c61d[...]"
    digests['SHA512'].hexdigest #=> "9b71d224[...]"

### Public Instance Methods

write (data)
Source

    # File lib/rubygems/package/digest_io.rb, line 54
    def write(data)
      result = @io.write data

      @digests.each do |_, digest|
        digest << data
      end

      result
    end

Writes `data` to the underlying `IO` and updates the digests