Ruby/Справочник/Dir

Материал из Викиучебника

Перейти к: навигация, поиск

Содержание

[править] Класс Dir

tmpdir - retrieve temporary directory path $Id: tmpdir.rb,v 1.5.2.1 2005/12/15 15:57:05 matz Exp $


Примеси

Enumerable (all?, any?, collect, detect, each_cons, each_slice, each_with_index, entries, enum_cons, enum_slice, enum_with_index, find, find_all, grep, group_by, include?, index_by, inject, map, max, member?, min, partition, reject, select, sort, sort_by, sum, to_a, to_set, zip),

Windows::DeviceIO (CTL_CODE, DeviceIoControl, FSCTL_SET_COMPRESSION, FSCTL_SET_SPARSE),

Windows::Directory (CreateDirectory, CreateDirectoryEx, CreateDirectoryExW, CreateDirectoryW, FindCloseChangeNotification, FindFirstChangeNotification, FindNextChangeNotification, GetCurrentDirectory, GetCurrentDirectoryW, ReadDirectoryChangesW, RemoveDirectory, RemoveDirectoryW, SetCurrentDirectory, SetCurrentDirectoryW),

Windows::Error (FormatMessage, FormatMessageW, GetLastError, SetErrorMode, SetLastError, SetLastErrorEx, get_last_error),

Windows::File (CopyFile, CopyFileEx, CreateFile, CreateHardLink, DecryptFile, DeleteFile, EncryptFile, GetBinaryType, GetFileAttributes, GetFileAttributesEx, GetFileSize, GetFileSizeEx, GetFileType, GetFullPathName, GetLongPathName, GetShortPathName, LockFile, LockFileEx, ReadFile, ReadFileEx, SetFileAttributes, UnlockFile, UnlockFileEx, WriteFile, WriteFileEx),

Windows::Shell (SHGetFolderPath, SHGetSpecialFolderLocation, SHGetSpecialFolderPath)

Константы

VERSION

Методы класса

[], chdir, chroot, create_junction, delete, empty?, entries, foreach, getwd, glob, junction?, mkdir, new, open, pwd, rmdir, tmpdir, unlink

Методы объекта

close, each, path, pos=, pos, read, rewind, seek, tell

[править] Dir::[]


 Dir[ string ] => array

Equivalent to calling dir.glob(string,0).

[править] Dir::chdir


 Dir.chdir( [ string] ) => 0
 Dir.chdir( [ string] ) {| path | block }  => anObject

Changes the current working directory of the process to the given string. When called without an argument, changes the directory to the value of the environment variable HOME, or LOGDIR. SystemCallError (probably Errno::ENOENT) if the target directory does not exist. If a block is given, it is passed the name of the new current directory, and the block is executed with that as the current directory. The original working directory is restored when the block exits. The return value of chdir is the value of the block. chdir blocks can be nested, but in a multi-threaded program an error will be raised if a thread attempts to open a chdir block while another thread has one open.

  Dir.chdir("/var/spool/mail")
  puts Dir.pwd
  Dir.chdir("/tmp") do
    puts Dir.pwd
    Dir.chdir("/usr") do
      puts Dir.pwd
    end
    puts Dir.pwd
  end
  puts Dir.pwd

produces:

  /var/spool/mail
  /tmp
  /usr
  /tmp
  /var/spool/mail

[править] Dir::chroot


 Dir.chroot( string ) => 0

Changes this process's idea of the file system root. Only a privileged process may make this call. Not available on all platforms. On Unix systems, see chroot(2) for more information.

[править] Dir::create_junction


 Dir::create_junction(to, from)

Creates the symlink to, linked to the existing directory from. If the to directory already exists, it must be empty or an error is raised.

[править] Dir::delete


 Dir.delete( string ) => 0
 Dir.rmdir( string ) => 0
 Dir.unlink( string ) => 0

Deletes the named directory. Raises a subclass of SystemCallError if the directory isn't empty.

[править] Dir::empty?


 Dir::empty?(path)

Returns whether or not path is empty. Returns false if path is not a directory, or contains any files other than '.' or '..'.

[править] Dir::entries


 Dir.entries( dirname ) => array

Returns an array containing all of the filenames in the given directory. Will raise a SystemCallError if the named directory doesn't exist.

  Dir.entries("testdir")   #=> [".", "..", "config.h", "main.rb"]

[править] Dir::foreach


 Dir.foreach( dirname ) {| filename | block }  => nil

Calls the block once for each entry in the named directory, passing the filename of each entry as a parameter to the block.

  Dir.foreach("testdir") {|x| puts "Got #{x}" }

produces:

  Got .
  Got ..
  Got config.h
  Got main.rb

[править] Dir::getwd


 Dir.getwd => string
 Dir.pwd => string

Returns the path to the current working directory of this process as a string.

  Dir.chdir("/tmp")   #=> 0
  Dir.getwd           #=> "/tmp"

[править] Dir::glob


 Dir.glob( string, [flags] ) => array
 Dir.glob( string, [flags] ) {| filename | block }  => nil

Returns the filenames found by expanding the pattern given in string, either as an array or as parameters to the block. Note that this pattern is not a regexp (it's closer to a shell glob). See File::fnmatch for the meaning of the flags parameter.

Matches any file. Can be restricted by other values in the glob. * will match all files; c* will match all files beginning with c; *c will match all files ending with c; and c will match all files that have c in them (including at the beginning or end). Equivalent to / .* /x in regexp. Matches directories recursively. Matches any one character. Equivalent to /.{1}/ in regexp. Matches any one character in set. Behaves exactly like character sets in Regexp, including set negation ([^a-z]). Matches either literal p or literal q. Matching literals may be more than one character in length. More than two literals may be specified. Equivalent to pattern alternation in regexp.

Escapes the next metacharacter.
  Dir["config.?"]                     #=> ["config.h"]
  Dir.glob("config.?")                #=> ["config.h"]
  Dir.glob("*.[a-z][a-z]")            #=> ["main.rb"]
  Dir.glob("*.[^r]*")                 #=> ["config.h"]
  Dir.glob("*.{rb,h}")                #=> ["main.rb", "config.h"]
  Dir.glob("*")                       #=> ["config.h", "main.rb"]
  Dir.glob("*", File::FNM_DOTMATCH)   #=> [".", "..", "config.h", "main.rb"]

  rbfiles = File.join("**", "*.rb")
  Dir.glob(rbfiles)                   #=> ["main.rb",
                                           "lib/song.rb",
                                           "lib/song/karaoke.rb"]
  libdirs = File.join("**", "lib")
  Dir.glob(libdirs)                   #=> ["lib"]

  librbfiles = File.join("**", "lib", "**", "*.rb")
  Dir.glob(librbfiles)                #=> ["lib/song.rb",
                                           "lib/song/karaoke.rb"]

  librbfiles = File.join("**", "lib", "*.rb")
  Dir.glob(librbfiles)                #=> ["lib/song.rb"]

[править] Dir::junction?


 Dir::junction?(path)

Returns whether or not path is a junction.

[править] Dir::mkdir


 Dir.mkdir( string [, integer] ) => 0

Makes a new directory named by string, with permissions specified by the optional parameter anInteger. The permissions may be modified by the value of File::umask, and are ignored on NT. Raises a SystemCallError if the directory cannot be created. See also the discussion of permissions in the class documentation for File.

[править] Dir::new


 Dir.new( string ) -> aDir

Returns a new directory object for the named directory.

[править] Dir::open


 Dir.open( string ) => aDir
 Dir.open( string ) {| aDir | block } => anObject

With no block, open is a synonym for Dir::new. If a block is present, it is passed aDir as a parameter. The directory is closed at the end of the block, and Dir::open returns the value of the block.

[править] Dir::pwd


 Dir.getwd => string
 Dir.pwd => string

Returns the path to the current working directory of this process as a string.

  Dir.chdir("/tmp")   #=> 0
  Dir.getwd           #=> "/tmp"

[править] Dir::rmdir


 Dir.delete( string ) => 0
 Dir.rmdir( string ) => 0
 Dir.unlink( string ) => 0

Deletes the named directory. Raises a subclass of SystemCallError if the directory isn't empty.

[править] Dir::tmpdir


 Dir::tmpdir()

Returns the operating system's temporary file path.

[править] Dir::unlink


 Dir.delete( string ) => 0
 Dir.rmdir( string ) => 0
 Dir.unlink( string ) => 0

Deletes the named directory. Raises a subclass of SystemCallError if the directory isn't empty.

[править] Dir#close


 dir.close => nil

Closes the directory stream. Any further attempts to access dir will raise an IOError.

  d = Dir.new("testdir")
  d.close   #=> nil

[править] Dir#each


 dir.each { |filename| block }  => dir

Calls the block once for each entry in this directory, passing the filename of each entry as a parameter to the block.

  d = Dir.new("testdir")
  d.each  {|x| puts "Got #{x}" }

produces:

  Got .
  Got ..
  Got config.h
  Got main.rb

[править] Dir#path


 dir.path => string or nil

Returns the path parameter passed to dir's constructor.

  d = Dir.new("..")
  d.path   #=> ".."

[править] Dir#pos


 dir.pos => integer
 dir.tell => integer

Returns the current position in dir. See also Dir#seek.

  d = Dir.new("testdir")
  d.tell   #=> 0
  d.read   #=> "."
  d.tell   #=> 12

[править] Dir#pos=


 dir.pos( integer ) => integer

Synonym for Dir#seek, but returns the position parameter.

  d = Dir.new("testdir")   #=> #<Dir:0x401b3c40>
  d.read                   #=> "."
  i = d.pos                #=> 12
  d.read                   #=> ".."
  d.pos = i                #=> 12
  d.read                   #=> ".."

[править] Dir#read


 dir.read => string or nil

Reads the next entry from dir and returns it as a string. Returns nil at the end of the stream.

  d = Dir.new("testdir")
  d.read   #=> "."
  d.read   #=> ".."
  d.read   #=> "config.h"

[править] Dir#rewind


 dir.rewind => dir

Repositions dir to the first entry.

  d = Dir.new("testdir")
  d.read     #=> "."
  d.rewind   #=> #<Dir:0x401b3fb0>
  d.read     #=> "."

[править] Dir#seek


 dir.seek( integer ) => dir

Seeks to a particular location in dir. integer must be a value returned by Dir#tell.

  d = Dir.new("testdir")   #=> #<Dir:0x401b3c40>
  d.read                   #=> "."
  i = d.tell               #=> 12
  d.read                   #=> ".."
  d.seek(i)                #=> #<Dir:0x401b3c40>
  d.read                   #=> ".."

[править] Dir#tell


 dir.pos => integer
 dir.tell => integer

Returns the current position in dir. See also Dir#seek.

  d = Dir.new("testdir")
  d.tell   #=> 0
  d.read   #=> "."
  d.tell   #=> 12