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

Class Method Summary

InputMethod - Inherited

.new

Creates a new input method object.

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.

  • #file_name readonly

    The file name of this input method, usually given during initialization.

InputMethod - Inherited

#file_name

The file name of this input method, usually given during initialization.
#prompt

The irb prompt associated with this input method.
#readable_after_eof?

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

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 138



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


  







Class Method Details



  

    .open(file, &block)  
  

  [ GitHub ]


  

  


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



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 150



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


  








  

    #file_name   (readonly)
  



  

    

The file name of this input method, usually given during initialization.


  



  [ GitHub ]


  

  


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



attr_reader :file_name


  







Instance Method Details



  

    #close  
  

  [ GitHub ]


  

  


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



def close
  @io.close
end


  








  

    #encoding  
  



  

    

The external encoding for standard input.


  



  [ GitHub ]


  

  


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



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 157



def gets
  print @prompt
  @io.gets
end


  








  

    #inspect  
  



  

    

For debug message


  



  [ GitHub ]


  

  


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



def inspect
  'FileInputMethod'
end