kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Enhance Tempfile docs [ci skip]

Browse source 
[ruby-core:90525] [Bug #15411]

From: zverok (Victor Shepelev) <zverok.offline@gmail.com>

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66415 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
nobu 2018-12-16 12:09:08 +00:00
parent 3b13bc634f
commit 13fd78c2e1
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
lib/tempfile.rb
View file

@ -47,7 +47,7 @@ require 'tmpdir'
# #
# file = Tempfile.new('foo') # file = Tempfile.new('foo')
# begin # begin
# ...do something with file... # # ...do something with file...
# ensure # ensure
# file.close # file.close
# file.unlink # deletes the temp file # file.unlink # deletes the temp file
@ -79,9 +79,6 @@ require 'tmpdir'
# same Tempfile object from multiple threads then you should protect it with a # same Tempfile object from multiple threads then you should protect it with a
# mutex. # mutex.
class Tempfile < DelegateClass(File) class Tempfile < DelegateClass(File)
# call-seq:
# new(basename = "", [tmpdir = Dir.tmpdir], [options])
#
# Creates a temporary file with permissions 0600 (= only readable and # Creates a temporary file with permissions 0600 (= only readable and
# writable by the owner) and opens it with mode "w+". # writable by the owner) and opens it with mode "w+".
# #
@ -114,10 +111,13 @@ class Tempfile < DelegateClass(File)
# +File.open+. This is mostly useful for specifying encoding # +File.open+. This is mostly useful for specifying encoding
# options, e.g.: # options, e.g.:
# #
# Tempfile.new('hello', '/home/aisaka', :encoding => 'ascii-8bit') # Tempfile.new('hello', '/home/aisaka', encoding: 'ascii-8bit')
# #
# # You can also omit the 'tmpdir' parameter: # # You can also omit the 'tmpdir' parameter:
# Tempfile.new('hello', :encoding => 'ascii-8bit') # Tempfile.new('hello', encoding: 'ascii-8bit')
#
# Note: +mode+ keyword argument, as accepted by Tempfile, can only be
# numeric, combination of the modes defined in File::Constants.
# #
# === Exceptions # === Exceptions
# #
@ -174,7 +174,7 @@ class Tempfile < DelegateClass(File)
# #
# file = Tempfile.new('foo') # file = Tempfile.new('foo')
# begin # begin
# ...do something with file... # # ...do something with file...
# ensure # ensure
# file.close # file.close
# file.unlink # deletes the temp file # file.unlink # deletes the temp file
@ -195,7 +195,7 @@ class Tempfile < DelegateClass(File)
# file = Tempfile.new('foo') # file = Tempfile.new('foo')
# file.unlink # On Windows this silently fails. # file.unlink # On Windows this silently fails.
# begin # begin
# ... do something with file ... # # ... do something with file ...
# ensure # ensure
# file.close! # Closes the file handle. If the file wasn't unlinked # file.close! # Closes the file handle. If the file wasn't unlinked
# # because #unlink failed, then this method will attempt # # because #unlink failed, then this method will attempt
@ -277,13 +277,13 @@ class Tempfile < DelegateClass(File)
# In any case, all arguments (<code>*args</code>) will be passed to Tempfile.new. # In any case, all arguments (<code>*args</code>) will be passed to Tempfile.new.
# #
# Tempfile.open('foo', '/home/temp') do |f| # Tempfile.open('foo', '/home/temp') do |f|
# ... do something with f ... # # ... do something with f ...
# end # end
# #
# # Equivalent: # # Equivalent:
# f = Tempfile.open('foo', '/home/temp') # f = Tempfile.open('foo', '/home/temp')
# begin # begin
# ... do something with f ... # # ... do something with f ...
# ensure # ensure
# f.close # f.close
# end # end
@ -321,7 +321,7 @@ end
# <code>**options</code>) will be treated as Tempfile.new. # <code>**options</code>) will be treated as Tempfile.new.
# #
# Tempfile.create('foo', '/home/temp') do |f| # Tempfile.create('foo', '/home/temp') do |f|
# ... do something with f ... # # ... do something with f ...
# end # end
# #
def Tempfile.create(basename="", tmpdir=nil, mode: 0, **options) def Tempfile.create(basename="", tmpdir=nil, mode: 0, **options)