123456789_123456789_123456789_123456789_123456789_

Class: IRB::FileInputMethod

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, InputMethod
Instance Chain:
self, InputMethod
Inherits: IRB::InputMethod
Defined in: lib/irb/input-method.rb

Overview

Use a File for IO with irb, see InputMethod

Constant Summary

InputMethod - Inherited

BASIC_WORD_BREAK_CHARACTERS

Class Method Summary

Instance Attribute Summary

  • #eof? ⇒ Boolean readonly

    Whether the end of this input method has been reached, returns true if there is no more data to read.

InputMethod - Inherited

#prompt

The irb prompt associated with this input method.

#prompting?,
#readable_after_eof?

Whether this input method is still readable when there is no more data to read.

#support_history_saving?

Instance Method Summary

InputMethod - Inherited

#gets

Reads the next line from this input method.

#inspect

For debug message.

#winsize

Constructor Details

.new(file) ⇒ FileInputMethod

Creates a new input method object

[ GitHub ]

  
# File 'lib/irb/input-method.rb', line 137

def initialize(file)
  @io = file.is_a?(IO) ? file : File.open(file)
  @external_encoding = @io.external_encoding
end

Class Method Details

.open(file, &block)

[ GitHub ]

  
# File 'lib/irb/input-method.rb', line 126

def open(file, &block)
  begin
    io = new(file)
    block.call(io)
  ensure
    io&.close
  end
end

Instance Attribute Details

#eof?Boolean (readonly)

Whether the end of this input method has been reached, returns true if there is no more data to read.

See IO#eof? for more information.

[ GitHub ]

  
# File 'lib/irb/input-method.rb', line 146

def eof?
  @io.closed? || @io.eof?
end

Instance Method Details

#close

[ GitHub ]

  
# File 'lib/irb/input-method.rb', line 168

def close
  @io.close
end

#encoding

The external encoding for standard input.

[ GitHub ]

  
# File 'lib/irb/input-method.rb', line 159

def encoding
  @external_encoding
end

#gets

Reads the next line from this input method.

See IO#gets for more information.

[ GitHub ]

  
# File 'lib/irb/input-method.rb', line 153

def gets
  print @prompt
  @io.gets
end

#inspect

For debug message

[ GitHub ]

  
# File 'lib/irb/input-method.rb', line 164

def inspect
  'FileInputMethod'
end