【Ruby3.x】Array::prepend()メソッドの使い方
prependメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
prependメソッドは、Arrayオブジェクトの先頭に指定された要素を追加するメソッドです。このメソッドは、既存の配列の前に新しい要素を挿入したい場合に利用されます。使い方はシンプルで、対象のArrayオブジェクトに対してprependメソッドを呼び出し、引数として追加したい要素を一つ以上指定します。
例えば、[3, 4]という配列に対してprepend(1, 2)を実行した場合、配列の先頭に1と2がこの順序で挿入され、配列は[1, 2, 3, 4]という内容になります。複数の要素を引数として渡す場合、それらの要素は引数に指定された順序を保ったまま、元の配列の既存要素よりも前に配置されます。
このprependメソッドは、元の配列オブジェクト自身を直接変更する「破壊的メソッド」です。そのため、メソッドが実行されると、呼び出し元の配列オブジェクトの内容が永久的に書き換えられます。新しい配列オブジェクトを生成するのではなく、既存の配列を変更する点に注意が必要です。戻り値としては、要素が追加され変更されたArrayオブジェクト自身が返されます。
ログの記録や、最新のデータをリストの最初に表示するといった、配列の先頭に情報を効率的に追加するシナリオで、このメソッドは非常に役立ちます。
構文(syntax)
1array.prepend(obj, ...)
引数(parameters)
*rest
- rest: 配列の先頭に追加する要素。任意個指定できます。
戻り値(return)
Array
prepend メソッドは、レシーバーである配列の先頭に指定された引数を追加した新しい配列を返します。元の配列は変更されません。