Maintenance of Ruby 2.0.0 ended on February 24, 2016. Read more

In Files

  • tmpdir.rb


Class/Module Index [+]



Public Class Methods

mktmpdir(prefix_suffix=nil, *rest) click to toggle source

::mktmpdir creates a temporary directory.

The directory is created with 0700 permission. Application should not change the permission to make the temporary directory accesible from other users.

The prefix and suffix of the name of the directory is specified by the optional first argument, prefix_suffix.

  • If it is not specified or nil, “d” is used as the prefix and no suffix is used.

  • If it is a string, it is used as the prefix and no suffix is used.

  • If it is an array, first element is used as the prefix and second element is used as a suffix.

Dir.mktmpdir {|dir| dir is ".../d..." }
Dir.mktmpdir("foo") {|dir| dir is ".../foo..." }
Dir.mktmpdir(["foo", "bar"]) {|dir| dir is ".../" }

The directory is created under ::tmpdir or the optional second argument tmpdir if non-nil value is given.

Dir.mktmpdir {|dir| dir is "#{Dir.tmpdir}/d..." }
Dir.mktmpdir(nil, "/var/tmp") {|dir| dir is "/var/tmp/d..." }

If a block is given, it is yielded with the path of the directory. The directory and its contents are removed using FileUtils.remove_entry before ::mktmpdir returns. The value of the block is returned.

Dir.mktmpdir {|dir|
  # use the directory...
  open("#{dir}/foo", "w") { ... }

If a block is not given, The path of the directory is returned. In this case, ::mktmpdir doesn’t remove the directory.

dir = Dir.mktmpdir
  # use the directory...
  open("#{dir}/foo", "w") { ... }
  # remove the directory.
  FileUtils.remove_entry dir
               # File tmpdir.rb, line 84
def Dir.mktmpdir(prefix_suffix=nil, *rest)
  path = Tmpname.create(prefix_suffix || "d", *rest) {|n| mkdir(n, 0700)}
  if block_given?
      yield path
      stat = File.stat(File.dirname(path))
      if stat.world_writable? and !stat.sticky?
        raise ArgumentError, "parent directory is world writable but not sticky"
      FileUtils.remove_entry path
tmpdir() click to toggle source

Returns the operating system’s temporary file path.

               # File tmpdir.rb, line 20
def Dir::tmpdir
  if $SAFE > 0
    tmp = @@systmpdir
    tmp = nil
    for dir in [ENV['TMPDIR'], ENV['TMP'], ENV['TEMP'], @@systmpdir, '/tmp', '.']
      next if !dir
      dir = File.expand_path(dir)
      if stat = File.stat(dir) and and stat.writable? and
          (!stat.world_writable? or stat.sticky?)
        tmp = dir
      end rescue nil
    raise ArgumentError, "could not find a temporary directory" if !tmp

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