Sha256: 37e56b61c76d5a4eb4c8deb6f8ba0e31ec453723070666508f532f08a0723467

Contents?: true

Size: 1.84 KB

Versions: 29

Compression:

Stored size: 1.84 KB

Contents

#
# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
#
# Copyright (C) 2014, Fletcher Nichol
#
# 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.

module Kitchen
  # Base64 encoder/decoder that operates on IO objects so as to minimize
  # memory allocations on large payloads.
  #
  # @author Fletcher Nichol <fnichol@nichol.ca>
  module Base64Stream
    # Encodes an input stream into a Base64 output stream. The input and ouput
    # objects must be opened IO resources. In other words, opening and closing
    # the resources are not the responsibilty of this method.
    #
    # @param io_in [#read] input stream
    # @param io_out [#write] output stream
    def self.strict_encode(io_in, io_out)
      buffer = ""
      io_out.write([buffer].pack("m0")) while io_in.read(3 * 1000, buffer)
      buffer = nil # rubocop:disable Lint/UselessAssignment
    end

    # Decodes a Base64 input stream into an output stream. The input and ouput
    # objects must be opened IO resources. In other words, opening and closing
    # the resources are not the responsibilty of this method.
    #
    # @param io_in [#read] input stream
    # @param io_out [#write] output stream
    def self.strict_decode(io_in, io_out)
      buffer = ""
      io_out.write(buffer.unpack("m0").first) while io_in.read(3 * 1000, buffer)
      buffer = nil # rubocop:disable Lint/UselessAssignment
    end
  end
end

Version data entries

29 entries across 29 versions & 2 rubygems

Version Path
test-kitchen-3.7.0 lib/kitchen/base64_stream.rb
test-kitchen-3.6.0 lib/kitchen/base64_stream.rb
test-kitchen-3.5.1 lib/kitchen/base64_stream.rb
test-kitchen-3.5.0 lib/kitchen/base64_stream.rb
test-kitchen-3.4.0 lib/kitchen/base64_stream.rb
test-kitchen-3.3.2 lib/kitchen/base64_stream.rb
test-kitchen-3.3.1 lib/kitchen/base64_stream.rb
test-kitchen-3.3.0 lib/kitchen/base64_stream.rb
test-kitchen-3.2.2 lib/kitchen/base64_stream.rb
test-kitchen-3.2.1 lib/kitchen/base64_stream.rb
test-kitchen-3.2.0 lib/kitchen/base64_stream.rb
test-kitchen-3.1.1 lib/kitchen/base64_stream.rb
test-kitchen-3.1.0 lib/kitchen/base64_stream.rb
test-kitchen-rsync-3.0.0.pre.3 lib/kitchen/base64_stream.rb
test-kitchen-rsync-3.0.0.pre.2 lib/kitchen/base64_stream.rb
test-kitchen-rsync-3.0.0.pre.1 lib/kitchen/base64_stream.rb
test-kitchen-3.0.0 lib/kitchen/base64_stream.rb
test-kitchen-2.12.0 lib/kitchen/base64_stream.rb
test-kitchen-2.11.2 lib/kitchen/base64_stream.rb
test-kitchen-2.11.1 lib/kitchen/base64_stream.rb