Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Ruby3.x】Dir::children()メソッドの使い方

childrenメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

childrenメソッドは、指定されたディレクトリ直下にあるファイルやサブディレクトリの名前を文字列の配列として取得するメソッドです。このメソッドは、Dirクラスに属し、ファイルシステム上のディレクトリの内容をプログラムから操作する際に利用されます。

引数には、内容を取得したいディレクトリのパスを文字列で指定します。引数を省略した場合は、現在の作業ディレクトリ(カレントディレクトリ)の直下にあるエントリ名が対象となります。戻り値は、Stringクラスのオブジェクトを要素とする配列です。この配列には、指定されたディレクトリに存在するすべてのファイル名とサブディレクトリ名が含まれます。

childrenメソッドの重要な特徴は、戻り値の配列に、カレントディレクトリを表す「.」と親ディレクトリを表す「..」が含まれない点です。これにより、純粋に指定したディレクトリの「子」となるエントリ名のみを簡単に一覧として取得でき、ディレクトリの内容を処理する際のコードを簡潔に保つことができます。

例えば、特定のディレクトリ内のファイルをリストアップしたり、サブディレクトリを探索したりするような場面で非常に役立ちます。指定されたパスのディレクトリが存在しない場合や、アクセス権がない場合には、Errno::ENOENTなどの例外が発生する可能性がありますので、適切なエラーハンドリングを検討することをお勧めします。

構文(syntax)

1Dir.children(path)

引数(parameters)

path

  • path: string: 検索対象のディレクトリパスを指定します。

戻り値(return)

Array

Dir.children は、指定されたディレクトリ内のファイルとサブディレクトリの名前を文字列の配列として返します。

関連コンテンツ