Extended maintenance of Ruby versions 1.8.7 and 1.9.2 will end on July 31, 2014. Read more

In Files

  • tempfile.rb

Parent

Class/Module Index [+]

Quicksearch

Tempfile

A class for managing temporary files. This library is written to be thread safe.

Constants

MAX_TRY

Public Class Methods

new(basename, tmpdir=Dir::tmpdir) click to toggle source

Creates a temporary file of mode 0600 in the temporary directory, opens it with mode “w+”, and returns a Tempfile object which represents the created temporary file. A Tempfile object can be treated just like a normal File object.

The basename parameter is used to determine the name of a temporary file. If an Array is given, the first element is used as prefix string and the second as suffix string, respectively. Otherwise it is treated as prefix string.

If tmpdir is omitted, the temporary directory is determined by Dir::tmpdir provided by ‘tmpdir.rb’. When $SAFE > 0 and the given tmpdir is tainted, it uses /tmp. (Note that ENV values are tainted by default)

 
               # File tempfile.rb, line 30
def initialize(basename, tmpdir=Dir::tmpdir)
  if $SAFE > 0 and tmpdir.tainted?
    tmpdir = '/tmp'
  end

  lock = nil
  n = failure = 0
  
  begin
    Thread.critical = true

    begin
      tmpname = File.join(tmpdir, make_tmpname(basename, n))
      lock = tmpname + '.lock'
      n += 1
    end while @@cleanlist.include?(tmpname) or
      File.exist?(lock) or File.exist?(tmpname)

    Dir.mkdir(lock)
  rescue
    failure += 1
    retry if failure < MAX_TRY
    raise "cannot generate tempfile `%s'" % tmpname
  ensure
    Thread.critical = false
  end

  @data = [tmpname]
  @clean_proc = Tempfile.callback(@data)
  ObjectSpace.define_finalizer(self, @clean_proc)

  @tmpfile = File.open(tmpname, File::RDWR|File::CREAT|File::EXCL, 0600)
  @tmpname = tmpname
  @@cleanlist << @tmpname
  @data[1] = @tmpfile
  @data[2] = @@cleanlist

  super(@tmpfile)

  # Now we have all the File/IO methods defined, you must not
  # carelessly put bare puts(), etc. after this.

  Dir.rmdir(lock)
end
            

Public Instance Methods

close(unlink_now=false) click to toggle source

Closes the file. If the optional flag is true, unlinks the file after closing.

If you don’t explicitly unlink the temporary file, the removal will be delayed until the object is finalized.

 
               # File tempfile.rb, line 108
def close(unlink_now=false)
  if unlink_now
    close!
  else
    _close
  end
end
            
close!() click to toggle source

Closes and unlinks the file.

 
               # File tempfile.rb, line 117
def close!
  _close
  @clean_proc.call
  ObjectSpace.undefine_finalizer(self)
  @data = @tmpname = nil
end
            
delete() click to toggle source
Alias for: unlink
length() click to toggle source
Alias for: size
open() click to toggle source

Opens or reopens the file with mode “r+”.

 
               # File tempfile.rb, line 89
def open
  @tmpfile.close if @tmpfile
  @tmpfile = File.open(@tmpname, 'r+')
  @data[1] = @tmpfile
  __setobj__(@tmpfile)
end
            
path() click to toggle source

Returns the full path name of the temporary file.

 
               # File tempfile.rb, line 142
def path
  @tmpname
end
            
size() click to toggle source

Returns the size of the temporary file. As a side effect, the IO buffer is flushed before determining the size.

 
               # File tempfile.rb, line 148
def size
  if @tmpfile
    @tmpfile.flush
    @tmpfile.stat.size
  else
    0
  end
end
            
Also aliased as: length

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.

blog comments powered by Disqus