Ruby 4.0 リファレンスマニュアル

class IO::ConsoleMode

[edit]

要約

端末の入出力モードを表すクラスです。

現在のモードは IO#console_mode で取得します。new でインスタンスを作ることはできません。取得したモードは dup でコピーできます。

このクラスのメソッドは self が保持するモードの値を変更するだけで、端末には反映されません。変更したモードを端末に反映するには IO#console_mode= に渡してください。

require "io/console"
mode = STDIN.console_mode
noecho = mode.dup
noecho.echo = false
STDIN.console_mode = noecho  # エコーバックを無効にする
begin
  password = STDIN.gets
ensure
  STDIN.console_mode = mode  # 元に戻す
end

[SEE_ALSO] IO#console_mode, IO#console_mode=

目次

インスタンスメソッド
定数

インスタンスメソッド

echo=(flag)Ruby 3.0 から Ruby 4.1 で削除[permalink][rdoc][edit]

文字入力時のエコーバックを有効にするかどうかを self に設定します。

[PARAM] flag:
真を指定した場合はエコーバックを有効に、偽を指定した場合は無効にします。

[SEE_ALSO] IO#echo=

raw(min: 1, time: 0, intr: false) -> IO::ConsoleModeRuby 3.0 から Ruby 4.1 で削除[permalink][rdoc][edit]

self を raw モードに変更したコピーを返します。self は変更しません。

キーワード引数の意味は IO#raw と同じです。

[PARAM] min:
入力操作 (read) 時に受信したい最小のバイト数を指定します。
[PARAM] time:
タイムアウトするまでの秒数を指定します。
[PARAM] intr:
true を指定した場合は、割り込み (interrupt) 、中止 (quit) 、停止 (suspend) の各シグナルを生成する制御文字が有効になります。
[EXCEPTION] ArgumentError:
intr に true または false 以外の値を指定した場合に発生します。

[SEE_ALSO] IO#raw

raw!(min: 1, time: 0, intr: false) -> selfRuby 3.0 から Ruby 4.1 で削除[permalink][rdoc][edit]

self を raw モードに変更します。

キーワード引数の意味は IO#raw と同じです。

[PARAM] min:
入力操作 (read) 時に受信したい最小のバイト数を指定します。
[PARAM] time:
タイムアウトするまでの秒数を指定します。
[PARAM] intr:
true を指定した場合は、割り込み (interrupt) 、中止 (quit) 、停止 (suspend) の各シグナルを生成する制御文字が有効になります。
[EXCEPTION] ArgumentError:
intr に true または false 以外の値を指定した場合に発生します。

[SEE_ALSO] IO#raw!

定数

VERSION -> StringRuby 3.0 から Ruby 4.1 で削除[permalink][rdoc][edit]

io/console ライブラリのバージョンを表す文字列です。