module Find

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

Public Class Methods

find

(*String | _ToPath paths, ?ignore_error: boolish) → Enumerator[String, nil]
(*String | _ToPath paths, ?ignore_error: boolish) { (String) → void } → nil

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/find/0/find.rbs, line 35
def self?.find: (*String | _ToPath paths, ?ignore_error: boolish) -> Enumerator[String, nil]
                | (*String | _ToPath paths, ?ignore_error: boolish) { (String) -> void } -> nil

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.

prune

() → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/find/0/find.rbs, line 48
def self?.prune: () -> void

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.