Sha256: 21ddff3f6e3279fbb0be8c29b893070a42c1e57cf6d47c64406926e73c829651

Contents?: true

Size: 1.36 KB

Versions: 43

Compression:

Stored size: 1.36 KB

Contents

# The `Find` module supports the top-down traversal of a set of file paths.
#
# For example, to total the size of all files under your home directory,
# ignoring anything in a "dot" directory (e.g. $HOME/.ssh):
#
#     require 'find'
#
#     total_size = 0
#
#     Find.find(ENV["HOME"]) do |path|
#       if FileTest.directory?(path)
#         if File.basename(path).start_with?('.')
#           Find.prune       # Don't look any further into this directory.
#         else
#           next
#         end
#       else
#         total_size += FileTest.size(path)
#       end
#     end
#
module Find
  # Calls the associated block with the name of every file and directory listed as
  # arguments, then recursively on their subdirectories, and so on.
  #
  # Returns an enumerator if no block is given.
  #
  # See the `Find` module documentation for an example.
  #
  def self?.find: (*String | _ToPath paths, ?ignore_error: boolish) -> Enumerator[String, nil]
                | (*String | _ToPath paths, ?ignore_error: boolish) { (String) -> void } -> nil

  # Skips the current file or directory, restarting the loop with the next entry.
  # If the current file is a directory, that directory will not be recursively
  # entered. Meaningful only within the block associated with Find::find.
  #
  # See the `Find` module documentation for an example.
  #
  def self?.prune: () -> void
end

Version data entries

43 entries across 43 versions & 1 rubygems

Version Path
rbs-1.3.1 stdlib/find/0/find.rbs
rbs-1.3.0 stdlib/find/0/find.rbs
rbs-1.2.1 stdlib/find/0/find.rbs
rbs-1.2.0 stdlib/find/0/find.rbs
rbs-1.1.1 stdlib/find/0/find.rbs
rbs-1.1.0 stdlib/find/0/find.rbs
rbs-1.0.6 stdlib/find/0/find.rbs
rbs-1.0.5 stdlib/find/0/find.rbs
rbs-1.0.4 stdlib/find/0/find.rbs
rbs-1.0.3 stdlib/find/0/find.rbs
rbs-1.0.2 stdlib/find/0/find.rbs
rbs-1.0.1 stdlib/find/0/find.rbs
rbs-1.0.0 stdlib/find/0/find.rbs
rbs-1.0.0.pre2 stdlib/find/0/find.rbs
rbs-1.0.0.pre stdlib/find/0/find.rbs
rbs-0.20.1 stdlib/find/0/find.rbs
rbs-0.20.0 stdlib/find/0/find.rbs
rbs-0.19.0 stdlib/find/0/find.rbs
rbs-0.18.1 stdlib/find/0/find.rbs
rbs-0.18.0 stdlib/find/0/find.rbs