http://www.kuqin.com/rubycndocument/man/built-in-class/class_object_io_file.html
File.split(pathname)
将pathname分为dirname和basename，并返回一个包含这两部分的数组。它与
[File.dirname(pathname), File.basename(pathname)]
相同。
访问文件用的类。通常使用open或File.open来生成。
超类:
- IO
包含的模块:
- File::Constants
ruby 1.8 特性： File::Constants已被包含在IO之中。
类方法:
File.atime(filename)
File.ctime(filename)
File.mtime(filename)
它们分别返回：文件的最终访问时间／文件状态的最终变更时间／最终更新时间(Time对象)。
若未能成功取得文件时间则引发Errno::EXXX异常。
File.basename(filename[, suffix])
返回filename中的最后一条斜线后面的部分。若给出了参数suffix且它和filename的尾部一致时，该方法会将其删除并返回结果。
例:
p File.basename("ruby/ruby.c") #=> "ruby.c"
p File.basename("ruby/ruby.c", ".c") #=> "ruby"
p File.basename("ruby/ruby.c", ".*") #=> "ruby"
p File.basename("ruby/ruby.exe", ".*") #=> "ruby"
另外，请参考File.dirname和File.extname。
从1.6.8到1.8.0版本间的修改(小结)
修改之后，File.basename的动作遵循SUSv3的规定。
p File.basename("foo/bar/") # => "bar" 以前是""
File.chmod(mode[, filename[, ...]])
File.lchmod(mode[, filename[, ...]]) (())
将文件的模式改为mode。它返回修改文件的个数。若修改模式失败则引发Errno::EXXX异常。
mode与chmod(2)一样，使用数值来指定其内容。
lchmod只修改符号连接中的连接本身的模式。在未安装lchmod(2)的系统中调用该方法时会引发NotImplementedError异常。
File.chown(owner, group[, filename[, ...]])
File.lchown(owner, group[, filename[, ...]]) (())
修改文件的owner和group。只有超级用户才能修改文件的owner和group。它返回修改文件的个数。若修改失败则引发Errno::EXXX异常。
owner、group与chown(2)一样，使用数值来指定其内容。若只想修改其中之一时，可以将不想修改的一方指定为nil或-1，这样就可以保持原状了。
lchown只修改符号连接中的连接本身的owner和group。在未安装lchown(2)的系统中调用该方法时会引发NotImplementedError异常。
File.delete(filename ... )
File.unlink(filename ... )
删除文件。返回删除文件的个数。若删除失败则引发Errno::EXXX异常。
该方法是用来删除普通文件的。而删除目录时要使用Dir.rmdir。
File.dirname(filename)
以字符串的形式返回filename中最后一条斜线之前的部分。若文件名中不含斜线，则返回"."(当前目录)。
例:
p File.dirname("dir/file.ext") # => "dir"
p File.dirname("file.ext") # => "."
另外，请参考File.basename, File.extname 。
ruby 1.8 特性
修改后，File.dirname的动作遵守SUSv3的规定。
p File.dirname("foo/bar/") # => "foo" 以前是、"foo/bar"
p File.dirname("foo//bar") # => "foo" 以前是、"foo/"
File.expand_path(path[, default_dir])
将path展开为绝对路径后返回该路径字符串。若path是相对路径则以default_dir为基准进行扩展。若没有default_dir或其值为nil时将使用当前目录。
开头的~会被扩展为主目录(使用环境变量HOME)，而~USER会被扩展为相应用户的主目录。
p File.expand_path("..") #=> "/home/matz/work"
p File.expand_path("..", "/tmp") #=> "/"
p File.expand_path("~") #=> "/home/matz"
p File.expand_path("~foo") #=> "/home/foo"
File.extname(filename) (())
返回文件名filename中的扩展名部分(跟在最后的"."之后的部分)。目录名中的"."和文件名头上的"."不会被看作扩展名的一部分。若filename中不含扩展名则返回空字符串。
p File.extname("foo/foo.txt") # => ".txt"
p File.extname("foo/foo.tar.gz") # => ".gz"
p File.extname("foo/bar") # => ""
p File.extname("foo/.bar") # => ""
p File.extname("foo.txt/bar") # => ""
p File.extname(".foo") # => ""
请参考File.basename, File.dirname。
File.fnmatch(pattern, path[, flags]) (())
File.fnmatch?(pattern, path[, flags]) (())
对文件名进行模式匹配(fnmatch(3))。若path与pattern相匹配则返回真。
pattern中可使用的通配符有`*', `?'和`[]'(与Dir.glob不同的是，这里不能使用`{}' 或 `**/')。
%w(foo foobar bar).each {|f|
p File.fnmatch("foo*", f)
}
# => true
true
false
flags中可以任意使用下列常数(定义在File::Constants模块中)中的若干个来改变模式匹配的运作情况。flags的默认值为0(不指定标识)。
将转义字符`\'看作普通字符。
# 默认情况下，带\的字符都会匹配该字符本身，
# 加上此标识后，\被当作普通字符处理。
p File.fnmatch('\a', 'a') # => true
p File.fnmatch('\a', '\a', File::FNM_NOESCAPE) # => true
# 在前者中，*发生了转义，只会匹配"*"字符
# 本身。
p File.fnmatch('\*', 'a') # => false
p File.fnmatch('\*', '\a', File::FNM_NOESCAPE) # => true
# 单独的\则不受此标识的影响，一律匹配于\。
# (请注意，在单引号内的字符串中，\\就是\)
p File.fnmatch('\\', '\\') # => true
p File.fnmatch('\\', '\\', File::FNM_NOESCAPE) # => true
通配符`*', `?', `[]'将不再匹配`/'。主要作用在shell的模式匹配中。
p File.fnmatch('*', '/', File::FNM_PATHNAME) # => false
p File.fnmatch('?', '/', File::FNM_PATHNAME) # => false
p File.fnmatch('[/]', '/', File::FNM_PATHNAME) # => false
进行匹配时，不区分大小写字母。
p File.fnmatch('A', 'a', File::FNM_CASEFOLD) # => true
通配符`*', `?', `[]'将匹配于开头的`.'。
p File.fnmatch('*', '.', File::FNM_DOTMATCH) # => true
p File.fnmatch('?', '.', File::FNM_DOTMATCH) # => true
p File.fnmatch('[.]', '.', File::FNM_DOTMATCH) # => true
p File.fnmatch('foo/*', 'foo/.', File::FNM_DOTMATCH) # => true
File.ftype(filename)
返回表示文件类型的字符串。该字符串应为下列之一。与File.lstat(filename).ftype相同(若为符号连接则返回"link")。
"file" "directory" "characterSpecial" "blockSpecial" "fifo" "link" "socket" "unknown"
File.join(item, item, ...)
将File::SEPARATOR置入其中连成字符串。它与
[item, item, ...].join(File::SEPARATOR)
相同。(此后可能提供DOSISH处理功能，但它依赖于系统环境。)
File.link(old, new)
生成一个指向old且名为new的硬连接(hard link)。old必须是现存的。
若成功生成硬连接就返回0。若失败则引发Errno::EXXX异常。
File.new(path[, mode [, perm]])
File.open(path[, mode [, perm]])
File.open(path[, mode [, perm]]) {|file| ... }
打开path所指文件并返回文件对象。若打开文件失败时引发Errno::EXXX异常。
参数mode, perm的用法与内部函数open相同。
open()可以带块。若带块调用时，将把文件对象传给块，然后开始块的运行。当块终止运行时，文件将被自动关闭。
带块调用时的返回值是块的执行结果。
File.readlink(path)
以字符串形式返回字符连接的连接对象。若读取连接失败则引发Errno::EXXX异常。
File.rename(from, to)
修改文件名称。若目录不同时，将进行移动。请参考rename(2)。若目标目录中有同名文件则会进行覆盖。
若成功移动文件就返回0。若失败则引发Errno::EXXX异常。
File.split(pathname)
将pathname分为dirname和basename，并返回一个包含这两部分的数组。它与
[File.dirname(pathname), File.basename(pathname)]
相同。
File.stat(filename)
File.lstat(filename)
生成并返回一个包含filename信息的File::Stat对象。若获取信息失败则引发Errno::EXXX异常。
lstat返回符号连接中的连接本身的信息。在未安装lstat(2)的系统中，它与File.stat相同。
请参考IO#stat,File#lstat 。
File.symlink(old, new)
生成一个指向old且名为new的符号连接。
若成功生成符号连接则返回0。若失败则引发Errno::EXXX异常。
File.truncate(path, length)
将path所指文件裁减为至多length字节的文件。
若成功更改大小时返回0。若失败则引发Errno::EXXX异常。
File.umask([umask])
修改umask。返回修改前的umask值。若省略umask则不修改，返回当前的umask值。
File.utime(atime, mtime[, filename[, ...]])
修改文件的最终访问时间和更新时间。返回修改的文件数。若修改失败则引发Errno::EXXX异常。
开始的两个参数必须是，表示时间的数值或Time类的实例。
File.blockdev?(path)
与FileTest.blockdev?相同。
File.chardev?(path)
与FileTest.chardev?相同。
File.directory?(path)
与FileTest.directory?相同。
File.executable?(path)
与FileTest.executable?相同。
File.executable_real?(path)
与FileTest.executable_real?相同。
File.exist?(path)
与FileTest.exist?相同。
File.file?(path)
与FileTest.file?相同。
File.grpowned?(path)
与FileTest.grpowned?相同。
File.owned?(path)
与FileTest.owned?相同。
File.pipe?(path)
与FileTest.pipe?相同。
File.readable?(path)
与FileTest.readable?相同。
File.readable_real?(path)
与FileTest.readable_real?相同。
File.setgid?(path)
与FileTest.setgid?相同。
File.setuid?(path)
与FileTest.setuid?相同。
File.size(path)
与FileTest.size相同。
File.size?(path)
与FileTest.size?相同。
File.socket?(path)
与FileTest.socket相同。
File.sticky?(path)
与FileTest.sticky?相同。
File.symlink?(path)
与FileTest.symlink?相同。
File.writable?(path)
与FileTest.writable?相同。
File.writable_real?(path)
与FileTest.writable_real?相同。
File.zero?(path)
与FileTest.zero?相同。
方法:
atime
ctime
mtime
它们分别返回：文件的最终访问时间／文件状态的最终变更时间／最终更新时间(Time对象)。
若未能成功取得文件时间则引发Errno::EXXX异常。
chmod(mode)
将文件模式修改为mode.若修改成功则返回0.若失败则引发Errno::EXXX异常.
mode同chmod(2)一样,使用数值来指定其内容.
chown(owner, group)
修改文件的owner和group.只有超级用户才能修改文件的owner和group.修改成功则返回0,失败则引发Errno::EXXX异常.
owner,group同chown(2)一样,使用数值来指定其内容.若将其指定为nil或-1的话,就可以保留现在的状态.
flock(operation)
锁定文件. 锁定成功时返回0. 失败则引发Errno::EXXX异常. 若在LOCK_NB状态下发生阻塞(block)则返回false.下列是可用的operation列表.
-
LOCK_SH共享锁. 若干个进程可同时共享锁定.
根据系统的不同,有时要求锁定对象必须是以读取模式("r","r+"等)打开的才行. 在这些系统中,若对不可读文件进行锁定时,可能会引发Errno::EBADF异常.
-
LOCK_EX排它锁.在某时刻,只有一个进程能控制锁.
根据系统的不同,有时要求锁定对象必须是以写入模式("w","r+"等)打开的才行. 在这些系统中,若对不可写文件进行锁定时,可能会引发Errno::EBADF异常.
-
LOCK_UN解锁.
除了这种显式的解锁以外, 当Ruby解释器结束(进程结束)时,也会自动解锁.
-
LOCK_NB非阻塞模式.
同
LOCK_SH | LOCK_NB一样,它可以借用or与其他operation一起使用. 若没有指定LOCK_NB的话,若在阻塞条件下调用flock时,该阻塞将会一直持续到解锁时.若指定了
LOCK_NB的话,若在阻塞时调用flock则返回false.所谓"阻塞时"是指发生下述情况
- 在其他进程已设置排它锁的情况下进行锁定
- 在其他进程已经锁定的情况下设置排它锁
的时候.
上述常数都被定义在模块中.
例:
f = File.open("/tmp/foo", "w")
f.flock(File::LOCK_EX)
puts "locked by process1"
fork {
f = File.open("/tmp/foo", "r")
f.flock(File::LOCK_SH)
puts "locked by process2"
sleep 5
puts "unlocked by process2"
}
sleep 5
f.flock(File::LOCK_UN)
puts "unlocked by process1"
sleep 1 # <- 为确保子进程能够抢先进行锁定而进行的 sleep
f.flock(File::LOCK_EX)
puts "re-locked by process1"
=> locked by process1
unlocked by process1
locked by process2
unlocked by process2
re-locked by process1
path
以字符串形式返回打开文件时使用的路径.
lstat
生成并返回一个包含文件状态信息的File::Stat对象.若未能成功取得文件信息则引发Errno::EXXX异常.
lstat只返回符号连接中的连接本身的信息. 在那些未安装lstat(2)的系统中,它与IO#stat相同.
另外,请参考IO#stat,File.stat和File.lstat.
truncate(length)
将文件裁剪成至多length字节大小的文件. 若文件并不是以写入模式打开的话,将引发IOError异常.
若修改成功则返回0,若失败则引发Errno::EXXX异常.
常数:
ALT_SEPARATOR
当系统的文件路径分隔符与SEPARATOR不同时,即可使用该常数.在MS-DOS等系统中是"\",而在UNIX 或Cygwin等系统中则是nil.
PATH_SEPARATOR
PATH环境变量的元素分隔符.在UNIX中是":",而在MS-DOS等系统中是";".
SEPARATOR
Separator
文件路径的分隔符. 例如,在将路径名传给处理文件的方法时就会用到它. 该分隔符使得脚本内的路径名的格式统一且不受环境的影响.其值为"/".
内部类:
Constants
包括File类的相关常数的模块. 请参考File::Constants.
Stat
表示stat结构体(请参考stat(2))的类. 请参考File::Stat.