Pathname (Class)

In: pathname.rb
Parent: Object

Pathname

Pathname represents a pathname which locates a file in a filesystem. It supports only Unix style pathnames. It does not represent the file itself. A Pathname can be relative or absolute. It’s not until you try to reference the file that it even matters whether the file exists or not.

Pathname is immutable. It has no method for destructive update.

The value of this class is to manipulate file path information in a neater way than standard Ruby provides. The examples below demonstrate the difference. All functionality from File, FileTest, and some from Dir and FileUtils is included, in an unsurprising way. It is essentially a facade for all of these, and more.

Examples

Example 1: Using Pathname

  require 'pathname'
  p = Pathname.new("/usr/bin/ruby")
  size = p.size              # 27662
  isdir = p.directory?       # false
  dir  = p.dirname           # Pathname:/usr/bin
  base = p.basename          # Pathname:ruby
  dir, base = p.split        # [Pathname:/usr/bin, Pathname:ruby]
  data = p.read
  p.open { |f| _ }
  p.each_line { |line| _ }

Example 2: Using standard Ruby

  p = "/usr/bin/ruby"
  size = File.size(p)        # 27662
  isdir = File.directory?(p) # false
  dir  = File.dirname(p)     # "/usr/bin"
  base = File.basename(p)    # "ruby"
  dir, base = File.split(p)  # ["/usr/bin", "ruby"]
  data = File.read(p)
  File.open(p) { |f| _ }
  File.foreach(p) { |line| _ }

Example 3: Special features

  p1 = Pathname.new("/usr/lib")   # Pathname:/usr/lib
  p2 = p1 + "ruby/1.8"            # Pathname:/usr/lib/ruby/1.8
  p3 = p1.parent                  # Pathname:/usr
  p4 = p2.relative_path_from(p3)  # Pathname:lib/ruby/1.8
  pwd = Pathname.pwd              # Pathname:/home/gavin
  pwd.absolute?                   # true
  p5 = Pathname.new "."           # Pathname:.
  p5 = p5 + "music/../articles"   # Pathname:music/../articles
  p5.cleanpath                    # Pathname:articles
  p5.realpath                     # Pathname:/home/gavin/articles
  p5.children                     # [Pathname:/home/gavin/articles/linux, ...]

Breakdown of functionality

Core methods

These methods are effectively manipulating a String, because that’s all a path is. Except for mountpoint?, children, and realpath, they don’t access the filesystem.

File status predicate methods

These methods are a facade for FileTest:

File property and manipulation methods

These methods are a facade for File:

Directory methods

These methods are a facade for Dir:

IO

These methods are a facade for IO:

Utilities

These methods are a mixture of Find, FileUtils, and others:

Method documentation

As the above section shows, most of the methods in Pathname are facades. The documentation for these methods generally just says, for instance, "See FileTest.writable?", as you should be familiar with the original method anyway, and its documentation (e.g. through ri) will contain more information. In some cases, a brief description will follow.

Methods

+   <=>   ==   ===   absolute?   atime   basename   blockdev?   chardev?   chdir   children   chmod   chown   chroot   cleanpath   ctime   delete   dir_foreach   directory?   dirname   each_entry   each_filename   each_line   entries   eql?   executable?   executable_real?   exist?   expand_path   extname   file?   find   fnmatch   fnmatch?   foreach   foreachline   freeze   ftype   getwd   glob   grpowned?   join   lchmod   lchown   link   lstat   make_link   make_symlink   mkdir   mkpath   mountpoint?   mtime   new   open   opendir   owned?   parent   pipe?   pwd   read   readable?   readable_real?   readlines   readlink   realpath   relative?   relative_path_from   rename   rmdir   rmtree   root?   setgid?   setuid?   size   size?   socket?   split   stat   sticky?   symlink   symlink?   sysopen   taint   to_s   to_str   truncate   unlink   untaint   utime   writable?   writable_real?   zero?  

Public Class methods

getwd()

See Dir.getwd. Returns the current working directory as a Pathname.

[Source]

# File pathname.rb, line 768
  def Pathname.getwd() Pathname.new(Dir.getwd) end
glob(*args) {|p| ...}

See Dir.glob. Returns or yields Pathname objects.

[Source]

# File pathname.rb, line 759
  def Pathname.glob(*args) # :yield: p

    if block_given?
      Dir.glob(*args) {|f| yield Pathname.new(f) }
    else
      Dir.glob(*args).map {|f| Pathname.new(f) }
    end
  end
new(path)

Create a Pathname object from the given String (or String-like object). If path contains a NUL character (\0), an ArgumentError is raised.

[Source]

# File pathname.rb, line 187
  def initialize(path)
    @path = path.to_str.dup

    if /\0/ =~ @path
      raise ArgumentError, "pathname contains \\0: #{@path.inspect}"
    end

    self.taint if @path.tainted?
  end
pwd()

Alias for getwd

Public Instance methods

+(other)

Pathname#+ appends a pathname fragment to this one to produce a new Pathname object. 

  p1 = Pathname.new("/usr")      # Pathname:/usr
  p2 = p1 + "bin/ruby"           # Pathname:/usr/bin/ruby
  p3 = p1 + "/etc/passwd"        # Pathname:/etc/passwd

This method doesn’t access the file system; it is pure string manipulation.

[Source]

# File pathname.rb, line 430
  def +(other)
    other = Pathname.new(other) unless Pathname === other

    return other if other.absolute?

    path1 = @path
    path2 = other.to_s
    while m2 = %{\A\.\.(?:/+|\z)}.match(path2) and
          m1 = %{(\A|/+)([^/]+)\z}.match(path1) and
          %{\A(?:\.|\.\.)\z} !~ m1[2]
      path1 = m1[1].empty? ? '.' : '/' if (path1 = m1.pre_match).empty?
      path2 = '.' if (path2 = m2.post_match).empty?
    end
    if %{\A/+\z} =~ path1
      while m2 = %{\A\.\.(?:/+|\z)}.match(path2)
        path2 = '.' if (path2 = m2.post_match).empty?
      end
    end

    return Pathname.new(path2) if path1 == '.'
    return Pathname.new(path1) if path2 == '.'

    if %{/\z} =~ path1
      Pathname.new(path1 + path2)
    else
      Pathname.new(path1 + '/' + path2)
    end
  end
<=>(other)

Provides for comparing pathnames, case-sensitively.

[Source]

# File pathname.rb, line 214
  def <=>(other)
    return nil unless Pathname === other
    @path.tr('/', "\0") <=> other.to_s.tr('/', "\0")
  end
==(other)

Compare this pathname with other. The comparison is string-based. Be aware that two different paths (foo.txt and ./foo.txt) can refer to the same file.

[Source]

# File pathname.rb, line 206
  def ==(other)
    return false unless Pathname === other
    other.to_s == @path
  end
===(other)

Alias for #==

absolute?()

Predicate method for testing whether a path is absolute. It returns true if the pathname begins with a slash.

[Source]

# File pathname.rb, line 401
  def absolute?
    %{\A/} =~ @path ? true : false
  end
atime()

See File.atime. Returns last access time.

[Source]

# File pathname.rb, line 595
  def atime() File.atime(@path) end
basename(*args)

See File.basename. Returns the last component of the path.

[Source]

# File pathname.rb, line 656
  def basename(*args) Pathname.new(File.basename(@path, *args)) end
blockdev?()

See FileTest.blockdev?.

[Source]

# File pathname.rb, line 690
  def blockdev?() FileTest.blockdev?(@path) end
chardev?()

See FileTest.chardev?.

[Source]

# File pathname.rb, line 693
  def chardev?() FileTest.chardev?(@path) end
chdir(&block)

Pathname#chdir is obsoleted at 1.8.1.

[Source]

# File pathname.rb, line 772
  def chdir(&block)
    warn "Pathname#chdir is obsoleted.  Use Dir.chdir."
    Dir.chdir(@path, &block)
  end
children(with_directory=true)

Returns the children of the directory (files and subdirectories, not recursive) as an array of Pathname objects. By default, the returned pathnames will have enough information to access the files. If you set with_directory to false, then the returned pathnames will contain the filename only.

For example: 

  p = Pathname("/usr/lib/ruby/1.8")
  p.children
      # -> [ Pathname:/usr/lib/ruby/1.8/English.rb,
             Pathname:/usr/lib/ruby/1.8/Env.rb,
             Pathname:/usr/lib/ruby/1.8/abbrev.rb, ... ]
  p.children(false)
      # -> [ Pathname:English.rb, Pathname:Env.rb, Pathname:abbrev.rb, ... ]

Note that the result never contain the entries . and .. in the directory because they are not children.

This method has existed since 1.8.1.

[Source]

# File pathname.rb, line 499
  def children(with_directory=true)
    with_directory = false if @path == '.'
    result = []
    Dir.foreach(@path) {|e|
      next if e == '.' || e == '..'
      if with_directory
        result << Pathname.new(File.join(@path, e))
      else
        result << Pathname.new(e)
      end
    }
    result
  end
chmod(mode)

See File.chmod. Changes permissions.

[Source]

# File pathname.rb, line 604
  def chmod(mode) File.chmod(mode, @path) end
chown(owner, group)

See File.chown. Change owner and group of file.

[Source]

# File pathname.rb, line 610
  def chown(owner, group) File.chown(owner, group, @path) end
chroot()

Pathname#chroot is obsoleted at 1.8.1.

[Source]

# File pathname.rb, line 778
  def chroot
    warn "Pathname#chroot is obsoleted.  Use Dir.chroot."
    Dir.chroot(@path)
  end
cleanpath(consider_symlink=false)

Returns clean pathname of self with consecutive slashes and useless dots removed. The filesystem is not accessed.

If consider_symlink is true, then a more conservative algorithm is used to avoid breaking symbolic linkages. This may retain more .. entries than absolutely necessary, but without accessing the filesystem, this can’t be avoided. See realpath.

[Source]

# File pathname.rb, line 244
  def cleanpath(consider_symlink=false)
    if consider_symlink
      cleanpath_conservative
    else
      cleanpath_aggressive
    end
  end
ctime()

See File.ctime. Returns last (directory entry, not file) change time.

[Source]

# File pathname.rb, line 598
  def ctime() File.ctime(@path) end
delete()

Alias for unlink

dir_foreach(*args, &block)

Pathname#dir_foreach is obsoleted at 1.8.1.

[Source]

# File pathname.rb, line 796
  def dir_foreach(*args, &block)
    warn "Pathname#dir_foreach is obsoleted.  Use Pathname#each_entry."
    each_entry(*args, &block)
  end
directory?()

See FileTest.directory?.

[Source]

# File pathname.rb, line 708
  def directory?() FileTest.directory?(@path) end
dirname()

See File.dirname. Returns all but the last component of the path.

[Source]

# File pathname.rb, line 659
  def dirname() Pathname.new(File.dirname(@path)) end
each_entry() {|p| ...}

Iterates over the entries (files and subdirectories) in the directory. It yields a Pathname object for each entry.

This method has existed since 1.8.1.

[Source]

# File pathname.rb, line 791
  def each_entry(&block) # :yield: p

    Dir.foreach(@path) {|f| yield Pathname.new(f) }
  end
each_filename() {|s| ...}

Iterates over each component of the path. 

  Pathname.new("/usr/bin/ruby").each_filename
    # yields "usr", "bin", and "ruby".

[Source]

# File pathname.rb, line 416
  def each_filename # :yield: s

    @path.scan(%{[^/]+}) { yield $& }
  end
each_line(*args) {|line| ...}

each_line iterates over the line in the file. It yields a String object for each line.

This method has existed since 1.8.1.

[Source]

# File pathname.rb, line 570
  def each_line(*args, &block) # :yield: line

    IO.foreach(@path, *args, &block)
  end
entries()

Return the entries (files and subdirectories) in the directory, each as a Pathname object.

[Source]

# File pathname.rb, line 785
  def entries() Dir.entries(@path).map {|f| Pathname.new(f) } end
eql?(other)

Alias for #==

executable?()

See FileTest.executable?.

[Source]

# File pathname.rb, line 696
  def executable?() FileTest.executable?(@path) end
executable_real?()

See FileTest.executable_real?.

[Source]

# File pathname.rb, line 699
  def executable_real?() FileTest.executable_real?(@path) end
exist?()

See FileTest.exist?.

[Source]

# File pathname.rb, line 702
  def exist?() FileTest.exist?(@path) end
expand_path(*args)

See File.expand_path.

[Source]

# File pathname.rb, line 665
  def expand_path(*args) Pathname.new(File.expand_path(@path, *args)) end
extname()

See File.extname. Returns the file’s extension.

[Source]

# File pathname.rb, line 662
  def extname() File.extname(@path) end
file?()

See FileTest.file?.

[Source]

# File pathname.rb, line 711
  def file?() FileTest.file?(@path) end
find() {|p| ...}

Pathname#find is an iterator to traverse a directory tree in a depth first manner. It yields a Pathname for each file under "this" directory.

Since it is implemented by find.rb, Find.prune can be used to control the traverse.

If self is ., yielded pathnames begin with a filename in the current directory, not ./.

[Source]

# File pathname.rb, line 825
  def find(&block) # :yield: p

    require 'find'
    if @path == '.'
      Find.find(@path) {|f| yield Pathname.new(f.sub(%{\A\./}, '')) }
    else
      Find.find(@path) {|f| yield Pathname.new(f) }
    end
  end
fnmatch(pattern, *args)

See File.fnmatch. Return true if the receiver matches the given pattern.

[Source]

# File pathname.rb, line 617
  def fnmatch(pattern, *args) File.fnmatch(pattern, @path, *args) end
fnmatch?(pattern, *args)

See File.fnmatch? (same as fnmatch).

[Source]

# File pathname.rb, line 620
  def fnmatch?(pattern, *args) File.fnmatch?(pattern, @path, *args) end
foreach(*args, &block)

This method is obsoleted at 1.8.1. Use each_line or each_entry.

[Source]

# File pathname.rb, line 869
  def foreach(*args, &block)
    warn "Pathname#foreach is obsoleted.  Use each_line or each_entry."
    if FileTest.directory? @path
      # For polymorphism between Dir.foreach and IO.foreach,

      # Pathname#foreach doesn't yield Pathname object.

      Dir.foreach(@path, *args, &block)
    else
      IO.foreach(@path, *args, &block)
    end
  end
foreachline(*args, &block)

Pathname#foreachline is obsoleted at 1.8.1. Use each_line.

[Source]

# File pathname.rb, line 575
  def foreachline(*args, &block)
    warn "Pathname#foreachline is obsoleted.  Use Pathname#each_line."
    each_line(*args, &block)
  end
freeze()

[Source]

# File pathname.rb, line 197
  def freeze() super; @path.freeze; self end
ftype()

See File.ftype. Returns "type" of file ("file", "directory", etc).

[Source]

# File pathname.rb, line 624
  def ftype() File.ftype(@path) end
grpowned?()

See FileTest.grpowned?.

[Source]

# File pathname.rb, line 705
  def grpowned?() FileTest.grpowned?(@path) end
join(*args)

Pathname#join joins pathnames.

path0.join(path1, …, pathN) is the same as path0 + path1 + … + pathN.

[Source]

# File pathname.rb, line 465
  def join(*args)
    args.unshift self
    result = args.pop
    result = Pathname.new(result) unless Pathname === result
    return result if result.absolute?
    args.reverse_each {|arg|
      arg = Pathname.new(arg) unless Pathname === arg
      result = arg + result
      return result if result.absolute?
    }
    result
  end
lchmod(mode)

See File.lchmod.

[Source]

# File pathname.rb, line 607
  def lchmod(mode) File.lchmod(mode, @path) end
lchown(owner, group)

See File.lchown.

[Source]

# File pathname.rb, line 613
  def lchown(owner, group) File.lchown(owner, group, @path) end
link(old)

Pathname#link is confusing and obsoleted because the receiver/argument order is inverted to corresponding system call.

[Source]

# File pathname.rb, line 673
  def link(old)
    warn 'Pathname#link is obsoleted.  Use Pathname#make_link.'
    File.link(old, @path)
  end
lstat()

See File.lstat.

[Source]

# File pathname.rb, line 644
  def lstat() File.lstat(@path) end
make_link(old)

See File.link. Creates a hard link.

[Source]

# File pathname.rb, line 627
  def make_link(old) File.link(old, @path) end
make_symlink(old)

See File.symlink. Creates a symbolic link.

[Source]

# File pathname.rb, line 647
  def make_symlink(old) File.symlink(old, @path) end
mkdir(*args)

See Dir.mkdir. Create the referenced directory.

[Source]

# File pathname.rb, line 802
  def mkdir(*args) Dir.mkdir(@path, *args) end
mkpath()

See FileUtils.mkpath. Creates a full path, including any intermediate directories that don’t yet exist.

[Source]

# File pathname.rb, line 839
  def mkpath
    require 'fileutils'
    FileUtils.mkpath(@path)
    nil
  end
mountpoint?()

mountpoint? returns true if self points to a mountpoint.

[Source]

# File pathname.rb, line 377
  def mountpoint?
    begin
      stat1 = self.lstat
      stat2 = self.parent.lstat
      stat1.dev == stat2.dev && stat1.ino == stat2.ino ||
        stat1.dev != stat2.dev
    rescue Errno::ENOENT
      false
    end
  end
mtime()

See File.mtime. Returns last modification time.

[Source]

# File pathname.rb, line 601
  def mtime() File.mtime(@path) end
open(*args) {|file| ...}

See File.open. Opens the file for reading or writing.

[Source]

# File pathname.rb, line 630
  def open(*args, &block) # :yield: file

    File.open(@path, *args, &block)
  end
opendir() {|dir| ...}

See Dir.open.

[Source]

# File pathname.rb, line 808
  def opendir(&block) # :yield: dir

    Dir.open(@path, &block)
  end
owned?()

See FileTest.owned?.

[Source]

# File pathname.rb, line 720
  def owned?() FileTest.owned?(@path) end
parent()

parent returns the parent directory.

This is same as self + ’..’.

[Source]

# File pathname.rb, line 372
  def parent
    self + '..'
  end
pipe?()

See FileTest.pipe?.

[Source]

# File pathname.rb, line 714
  def pipe?() FileTest.pipe?(@path) end
read(*args)

See IO.read. Returns all the bytes from the file, or the first N if specified.

[Source]

# File pathname.rb, line 582
  def read(*args) IO.read(@path, *args) end
readable?()

See FileTest.readable?.

[Source]

# File pathname.rb, line 723
  def readable?() FileTest.readable?(@path) end
readable_real?()

See FileTest.readable_real?.

[Source]

# File pathname.rb, line 726
  def readable_real?() FileTest.readable_real?(@path) end
readlines(*args)

See IO.readlines. Returns all the lines from the file.

[Source]

# File pathname.rb, line 585
  def readlines(*args) IO.readlines(@path, *args) end
readlink()

See File.readlink. Read symbolic link.

[Source]

# File pathname.rb, line 635
  def readlink() Pathname.new(File.readlink(@path)) end
realpath(*args)

Returns a real (absolute) pathname of self in the actual filesystem. The real pathname doesn’t contain symlinks or useless dots.

No arguments should be given; the old behaviour is obsoleted.

[Source]

# File pathname.rb, line 308
  def realpath(*args)
    unless args.empty?
      warn "The argument for Pathname#realpath is obsoleted."
    end
    force_absolute = args.fetch(0, true)

    if %{\A/} =~ @path
      top = '/'
      unresolved = @path.scan(%{[^/]+})
    elsif force_absolute
      # Although POSIX getcwd returns a pathname which contains no symlink,

      # 4.4BSD-Lite2 derived getcwd may return the environment variable $PWD

      # which may contain a symlink.

      # So the return value of Dir.pwd should be examined.

      top = '/'
      unresolved = Dir.pwd.scan(%{[^/]+}) + @path.scan(%{[^/]+})
    else
      top = ''
      unresolved = @path.scan(%{[^/]+})
    end
    resolved = []

    until unresolved.empty?
      case unresolved.last
      when '.'
        unresolved.pop
      when '..'
        resolved.unshift unresolved.pop
      else
        loop_check = {}
        while (stat = File.lstat(path = top + unresolved.join('/'))).symlink?
          symlink_id = "#{stat.dev}:#{stat.ino}"
          raise Errno::ELOOP.new(path) if loop_check[symlink_id]
          loop_check[symlink_id] = true
          if %{\A/} =~ (link = File.readlink(path))
            top = '/'
            unresolved = link.scan(%{[^/]+})
          else
            unresolved[-1,1] = link.scan(%{[^/]+})
          end
        end
        next if (filename = unresolved.pop) == '.'
        if filename != '..' && resolved.first == '..'
          resolved.shift
        else
          resolved.unshift filename
        end
      end
    end

    if top == '/'
      resolved.shift while resolved[0] == '..'
    end
    
    if resolved.empty?
      Pathname.new(top.empty? ? '.' : '/')
    else
      Pathname.new(top + resolved.join('/'))
    end
  end
relative?()

The opposite of absolute?

[Source]

# File pathname.rb, line 406
  def relative?
    !absolute?
  end
relative_path_from(base_directory)

relative_path_from returns a relative path from the argument to the receiver. If self is absolute, the argument must be absolute too. If self is relative, the argument must be relative too.

relative_path_from doesn’t access the filesystem. It assumes no symlinks.

ArgumentError is raised when it cannot find a relative path.

This method has existed since 1.8.1.

[Source]

# File pathname.rb, line 524
  def relative_path_from(base_directory)
    if self.absolute? != base_directory.absolute?
      raise ArgumentError,
        "relative path between absolute and relative path: #{self.inspect}, #{base_directory.inspect}"
    end

    dest = []
    self.cleanpath.each_filename {|f|
      next if f == '.'
      dest << f
    }

    base = []
    base_directory.cleanpath.each_filename {|f|
      next if f == '.'
      base << f
    }

    while !base.empty? && !dest.empty? && base[0] == dest[0]
      base.shift
      dest.shift
    end

    if base.include? '..'
      raise ArgumentError, "base_directory has ..: #{base_directory.inspect}"
    end

    base.fill '..'
    relpath = base + dest
    if relpath.empty?
      Pathname.new(".")
    else
      Pathname.new(relpath.join('/'))
    end
  end
rename(to)

See File.rename. Rename the file.

[Source]

# File pathname.rb, line 638
  def rename(to) File.rename(@path, to) end
rmdir()

See Dir.rmdir. Remove the referenced directory.

[Source]

# File pathname.rb, line 805
  def rmdir() Dir.rmdir(@path) end
rmtree()

See FileUtils.rm_r. Deletes a directory and all beneath it.

[Source]

# File pathname.rb, line 846
  def rmtree
    # The name "rmtree" is borrowed from File::Path of Perl.

    # File::Path provides "mkpath" and "rmtree".

    require 'fileutils'
    FileUtils.rm_r(@path)
    nil
  end
root?()

root? is a predicate for root directories. I.e. it returns true if the pathname consists of consecutive slashes.

It doesn’t access actual filesystem. So it may return false for some pathnames which points to roots such as /usr/...

[Source]

# File pathname.rb, line 395
  def root?
    %{\A/+\z} =~ @path ? true : false
  end
setgid?()

See FileTest.setgid?.

[Source]

# File pathname.rb, line 732
  def setgid?() FileTest.setgid?(@path) end
setuid?()

See FileTest.setuid?.

[Source]

# File pathname.rb, line 729
  def setuid?() FileTest.setuid?(@path) end
size()

See FileTest.size.

[Source]

# File pathname.rb, line 735
  def size() FileTest.size(@path) end
size?()

See FileTest.size?.

[Source]

# File pathname.rb, line 738
  def size?() FileTest.size?(@path) end
socket?()

See FileTest.socket?.

[Source]

# File pathname.rb, line 717
  def socket?() FileTest.socket?(@path) end
split()

See File.split. Returns the dirname and the basename in an Array.

[Source]

# File pathname.rb, line 669
  def split() File.split(@path).map {|f| Pathname.new(f) } end
stat()

See File.stat. Returns a File::Stat object.

[Source]

# File pathname.rb, line 641
  def stat() File.stat(@path) end
sticky?()

See FileTest.sticky?.

[Source]

# File pathname.rb, line 741
  def sticky?() FileTest.sticky?(@path) end
symlink(old)

Pathname#symlink is confusing and obsoleted because the receiver/argument order is inverted to corresponding system call.

[Source]

# File pathname.rb, line 680
  def symlink(old)
    warn 'Pathname#symlink is obsoleted.  Use Pathname#make_symlink.'
    File.symlink(old, @path)
  end
symlink?()

See FileTest.symlink?.

[Source]

# File pathname.rb, line 744
  def symlink?() FileTest.symlink?(@path) end
sysopen(*args)

See IO.sysopen.

[Source]

# File pathname.rb, line 588
  def sysopen(*args) IO.sysopen(@path, *args) end
taint()

[Source]

# File pathname.rb, line 198
  def taint() super; @path.taint; self end
to_s()

Return the path as a String.

[Source]

# File pathname.rb, line 224
  def to_s
    @path.dup
  end
to_str()

Alias for to_s

truncate(length)

See File.truncate. Truncate the file to length bytes.

[Source]

# File pathname.rb, line 650
  def truncate(length) File.truncate(@path, length) end
unlink()

Removes a file or directory, using File.unlink or Dir.unlink as necessary.

[Source]

# File pathname.rb, line 859
  def unlink()
    if FileTest.directory? @path
      Dir.unlink @path
    else
      File.unlink @path
    end
  end
untaint()

[Source]

# File pathname.rb, line 199
  def untaint() super; @path.untaint; self end
utime(atime, mtime)

See File.utime. Update the access and modification times.

[Source]

# File pathname.rb, line 653
  def utime(atime, mtime) File.utime(atime, mtime, @path) end
writable?()

See FileTest.writable?.

[Source]

# File pathname.rb, line 747
  def writable?() FileTest.writable?(@path) end
writable_real?()

See FileTest.writable_real?.

[Source]

# File pathname.rb, line 750
  def writable_real?() FileTest.writable_real?(@path) end
zero?()

See FileTest.zero?.

[Source]

# File pathname.rb, line 753
  def zero?() FileTest.zero?(@path) end

[Validate]