Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more

In Files

  • rubygems/package/tar_writer.rb

Parent

Methods

Class/Module Index [+]

Quicksearch

Gem::Package::TarWriter::BoundedStream

IO wrapper that allows writing a limited amount of data

Attributes

limit[R]

Maximum number of bytes that can be written

written[R]

Number of bytes written

Public Class Methods

new(io, limit) click to toggle source

Wraps io and allows up to limit bytes to be written

 
               # File rubygems/package/tar_writer.rb, line 31
def initialize(io, limit)
  @io = io
  @limit = limit
  @written = 0
end
            

Public Instance Methods

write(data) click to toggle source

Writes data onto the IO, raising a FileOverflow exception if the number of bytes will be more than limit

 
               # File rubygems/package/tar_writer.rb, line 41
def write(data)
  if data.size + @written > @limit
    raise FileOverflow, "You tried to feed more data than fits in the file."
  end
  @io.write data
  @written += data.size
  data.size
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.