rbs 2.8.4 → 3.8.1

data/core/file_test.rbs

@@ -6,43 +6,52 @@
 module FileTest
   # <!--
   #   rdoc-file=file.c
-  #   - File.blockdev?(file_name)   ->  true or false
+  #   - File.blockdev?(filepath) -> true or false
   # -->
-  # Returns `true` if the named file is a block device.
+  # Returns `true` if `filepath` points to a block device, `false` otherwise:
   #
-  # *file_name* can be an IO object.
+  #     File.blockdev?('/dev/sda1')       # => true
+  #     File.blockdev?(File.new('t.tmp')) # => false
   #
-  def self?.blockdev?: (String | IO file_name) -> bool
+  def self?.blockdev?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
-  #   - File.chardev?(file_name)   ->  true or false
+  #   - File.chardev?(filepath) -> true or false
   # -->
-  # Returns `true` if the named file is a character device.
+  # Returns `true` if `filepath` points to a character device, `false` otherwise.
   #
-  # *file_name* can be an IO object.
+  #     File.chardev?($stdin)     # => true
+  #     File.chardev?('t.txt')     # => false
   #
-  def self?.chardev?: (String | IO file_name) -> bool
+  def self?.chardev?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
-  #   - File.directory?(file_name)   ->  true or false
+  #   - File.directory?(path) -> true or false
   # -->
-  # Returns `true` if the named file is a directory, or a symlink that points at a
-  # directory, and `false` otherwise.
+  # With string `object` given, returns `true` if `path` is a string path leading
+  # to a directory, or to a symbolic link to a directory; `false` otherwise:
   #
-  # *file_name* can be an IO object.
+  #     File.directory?('.')              # => true
+  #     File.directory?('foo')            # => false
+  #     File.symlink('.', 'dirlink')      # => 0
+  #     File.directory?('dirlink')        # => true
+  #     File.symlink('t,txt', 'filelink') # => 0
+  #     File.directory?('filelink')       # => false
   #
-  #     File.directory?(".")
+  # Argument `path` can be an IO object.
   #
-  def self?.directory?: (String | IO file_name) -> bool
+  def self?.directory?: (path | io file_name) -> bool
 
   # <!-- rdoc-file=file.c -->
   # Returns `true` if the named file exists and has a zero size.
   #
   # *file_name* can be an IO object.
   #
-  def self?.empty?: (String | IO file_name) -> bool
+  alias empty? zero?
+
+  alias self.empty? self.zero?
 
   # <!--
   #   rdoc-file=file.c
@@ -58,7 +67,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not executable by the effective user/group.
   #
-  def self?.executable?: (String file_name) -> bool
+  def self?.executable?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -74,7 +83,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not executable by the real user/group.
   #
-  def self?.executable_real?: (String file_name) -> bool
+  def self?.executable_real?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -86,7 +95,7 @@ module FileTest
   #
   # "file exists" means that stat() or fstat() system call is successful.
   #
-  def self?.exist?: (String | IO file_name) -> bool
+  def self?.exist?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -99,7 +108,7 @@ module FileTest
   # If the `file` argument is a symbolic link, it will resolve the symbolic link
   # and use the file referenced by the link.
   #
-  def self?.file?: (String | IO file) -> bool
+  def self?.file?: (path | io file) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -110,7 +119,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.grpowned?: (String | IO file_name) -> bool
+  def self?.grpowned?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -130,7 +139,7 @@ module FileTest
   #     open("d", "w") {}
   #     p File.identical?("a", "d")      #=> false
   #
-  def self?.identical?: (String | IO file_1, String | IO file_2) -> bool
+  def self?.identical?: (path | io file_1, path | io file_2) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -141,17 +150,19 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.owned?: (String | IO file_name) -> bool
+  def self?.owned?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
-  #   - File.pipe?(file_name)   ->  true or false
+  #   - File.pipe?(filepath) -> true or false
   # -->
-  # Returns `true` if the named file is a pipe.
+  # Returns `true` if `filepath` points to a pipe, `false` otherwise:
   #
-  # *file_name* can be an IO object.
+  #     File.mkfifo('tmp/fifo')
+  #     File.pipe?('tmp/fifo') # => true
+  #     File.pipe?('t.txt')    # => false
   #
-  def self?.pipe?: (String | IO file_name) -> bool
+  def self?.pipe?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -163,7 +174,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not readable by the effective user/group.
   #
-  def self?.readable?: (String file_name) -> bool
+  def self?.readable?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -175,7 +186,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not readable by the real user/group.
   #
-  def self?.readable_real?: (String file_name) -> bool
+  def self?.readable_real?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -185,7 +196,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.setgid?: (String | IO file_name) -> bool
+  def self?.setgid?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -195,7 +206,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.setuid?: (String | IO file_name) -> bool
+  def self?.setuid?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -205,7 +216,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.size: (String | IO file_name) -> Integer
+  def self?.size: (path | io file_name) -> Integer
 
   # <!--
   #   rdoc-file=file.c
@@ -216,17 +227,19 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.size?: (String | IO file_name) -> Integer?
+  def self?.size?: (path | io file_name) -> Integer?
 
   # <!--
   #   rdoc-file=file.c
-  #   - File.socket?(file_name)   ->  true or false
+  #   - File.socket?(filepath)   ->  true or false
   # -->
-  # Returns `true` if the named file is a socket.
+  # Returns `true` if `filepath` points to a socket, `false` otherwise:
   #
-  # *file_name* can be an IO object.
+  #     require 'socket'
+  #     File.socket?(Socket.new(:INET, :STREAM)) # => true
+  #     File.socket?(File.new('t.txt'))          # => false
   #
-  def self?.socket?: (String | IO file_name) -> bool
+  def self?.socket?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -236,15 +249,19 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.sticky?: (String | IO file_name) -> bool
+  def self?.sticky?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
-  #   - File.symlink?(file_name)   ->  true or false
+  #   - File.symlink?(filepath) -> true or false
   # -->
-  # Returns `true` if the named file is a symbolic link.
+  # Returns `true` if `filepath` points to a symbolic link, `false` otherwise:
+  #
+  #     symlink = File.symlink('t.txt', 'symlink')
+  #     File.symlink?('symlink') # => true
+  #     File.symlink?('t.txt')   # => false
   #
-  def self?.symlink?: (String file_name) -> bool
+  def self?.symlink?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -260,7 +277,7 @@ module FileTest
   #     m = File.world_readable?("/etc/passwd")
   #     sprintf("%o", m)                              #=> "644"
   #
-  def self?.world_readable?: (String | IO file_name) -> Integer?
+  def self?.world_readable?: (path | io file_name) -> Integer?
 
   # <!--
   #   rdoc-file=file.c
@@ -276,7 +293,7 @@ module FileTest
   #     m = File.world_writable?("/tmp")
   #     sprintf("%o", m)                              #=> "777"
   #
-  def self?.world_writable?: (String | IO file_name) -> Integer?
+  def self?.world_writable?: (path | io file_name) -> Integer?
 
   # <!--
   #   rdoc-file=file.c
@@ -288,7 +305,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not writable by the effective user/group.
   #
-  def self?.writable?: (String file_name) -> bool
+  def self?.writable?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -300,7 +317,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not writable by the real user/group.
   #
-  def self?.writable_real?: (String file_name) -> bool
+  def self?.writable_real?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -310,5 +327,5 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.zero?: (String | IO file_name) -> bool
+  def self?.zero?: (path | io file_name) -> bool
 end