ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: opt / alt / ruby34 / share / ri / system / IO

U:RDoc::AnyMethod[iI"	read:ETI"IO#read;TF:publico:RDoc::Markup::Document:@parts[o:RDoc::Markup::Paragraph;	[I"HReads bytes from the stream; the stream must be opened for reading ;TI"6(see {Access Modes}[rdoc-ref:File@Access+Modes]):;To:RDoc::Markup::BlankLine�o:RDoc::Markup::List:
@type:BULLET:@items[o:RDoc::Markup::ListItem:@label0;	[o;
;	[I"HIf +maxlen+ is +nil+, reads all bytes using the stream's data mode.;To;;0;	[o;
;	[I"9Otherwise reads up to +maxlen+ bytes in binary mode.;T@o;
;	[I"FReturns a string (either a new string or the given +out_string+) ;TI" containing the bytes read. ;TI"JThe encoding of the string depends on both +maxLen+ and +out_string+:;T@o;;
;;[o;;0;	[o;
;	[I"9+maxlen+ is +nil+: uses internal encoding of +self+ ;TI"4(regardless of whether +out_string+ was given).;To;;0;	[o;
;	[I"+maxlen+ not +nil+:;T@o;;
;;[o;;0;	[o;
;	[I"?+out_string+ given: encoding of +out_string+ not modified.;To;;0;	[o;
;	[I"0+out_string+ not given: ASCII-8BIT is used.;T@o;
;	[I")<b>Without Argument +out_string+</b>;T@o;
;	[I",When argument +out_string+ is omitted, ;TI"(the returned value is a new string:;T@o:RDoc::Markup::Verbatim;	[
I"f = File.new('t.txt')
;TI"f.read
;TI"A# => "First line\nSecond line\n\nFourth line\nFifth line\n"
;TI"f.rewind
;TI"<f.read(30) # => "First line\r\nSecond line\r\n\r\nFou"
;TI"2f.read(30) # => "rth line\r\nFifth line\r\n"
;TI"f.read(30) # => nil
;TI"
f.close
;T:@format0o;
;	[I"2If +maxlen+ is zero, returns an empty string.;T@o;
;	[I"'<b> With Argument +out_string+</b>;T@o;
;	[I"*When argument +out_string+ is given, ;TI"Cthe returned value is +out_string+, whose content is replaced:;T@o;;	[I"f = File.new('t.txt')
;TI"s = 'foo'      # => "foo"
;TI"Pf.read(nil, s) # => "First line\nSecond line\n\nFourth line\nFifth line\n"
;TI"Ps              # => "First line\nSecond line\n\nFourth line\nFifth line\n"
;TI"f.rewind
;TI"s = 'bar'
;TI"@f.read(30, s)  # => "First line\r\nSecond line\r\n\r\nFou"
;TI"@s              # => "First line\r\nSecond line\r\n\r\nFou"
;TI"s = 'baz'
;TI"6f.read(30, s)  # => "rth line\r\nFifth line\r\n"
;TI"6s              # => "rth line\r\nFifth line\r\n"
;TI"s = 'bat'
;TI"f.read(30, s)  # => nil
;TI"s              # => ""
;TI"
f.close
;T;0o;
;	[I"CNote that this method behaves like the fread() function in C. ;TI"GThis means it retries to invoke read(2) system calls to read data ;TI".with the specified maxlen (or until EOF).;T@o;
;	[I"LThis behavior is preserved even if the stream is in non-blocking mode. ;TI"E(This method is non-blocking-flag insensitive as other methods.);T@o;
;	[I"AIf you need the behavior like a single read(2) system call, ;TI"9consider #readpartial, #read_nonblock, and #sysread.;T@o;
;	[I"Related: IO#write.;T:
@fileI"	io.c;T:0@omit_headings_from_table_of_contents_below0I"Lread(maxlen = nil, out_string = nil) -> new_string, out_string, or nil
;T0[�I"(p1 = v1, p2 = v2);T@vFI"IO;TcRDoc::NormalClass00

[+] ..
[-] raw-i.ri [edit]
[-] each_byte-i.ri [edit]
[-] echo%3f-i.ri [edit]
[-] nonblock-i.ri [edit]
[-] scroll_forward-i.ri [edit]
[-] copy_stream-c.ri [edit]
[-] goto-i.ri [edit]
[-] erase_line-i.ri [edit]
[-] readchar-i.ri [edit]
[+] EINPROGRESSWaitReadable
[-] write-c.ri [edit]
[-] getch-i.ri [edit]
[-] isatty-i.ri [edit]
[-] readlines-i.ri [edit]
[-] ioctl-i.ri [edit]
[-] sysseek-i.ri [edit]
[-] try_convert-c.ri [edit]
[+] EINPROGRESSWaitWritable
[-] readlines-c.ri [edit]
[-] oflush-i.ri [edit]
[-] %3c%3c-i.ri [edit]
[-] binwrite-c.ri [edit]
[-] eof-i.ri [edit]
[-] ungetc-i.ri [edit]
[-] ttyname-i.ri [edit]
[+] generic_readable
[-] pwrite-i.ri [edit]
[-] console_mode-i.ri [edit]
[-] winsize-i.ri [edit]
[-] nonblock%3d-i.ri [edit]
[-] set_encoding_by_bom-i.ri [edit]
[-] closed%3f-i.ri [edit]
[-] wait_readable-i.ri [edit]
[+] Buffer
[-] sync%3d-i.ri [edit]
[-] sysread-i.ri [edit]
[-] each_line-i.ri [edit]
[-] echo%3d-i.ri [edit]
[-] raw%21-i.ri [edit]
[-] cdesc-IO.ri [edit]
[-] read_nonblock-i.ri [edit]
[-] rewind-i.ri [edit]
[-] binmode%3f-i.ri [edit]
[-] close_on_exec%3f-i.ri [edit]
[-] write_nonblock-i.ri [edit]
[+] generic_writable
[-] expect-i.ri [edit]
[-] flush-i.ri [edit]
[-] lineno-i.ri [edit]
[-] stat-i.ri [edit]
[-] new-c.ri [edit]
[-] printf-i.ri [edit]
[-] cursor_up-i.ri [edit]
[-] autoclose%3f-i.ri [edit]
[-] cooked%21-i.ri [edit]
[-] wait-i.ri [edit]
[-] getc-i.ri [edit]
[-] clear_screen-i.ri [edit]
[-] external_encoding-i.ri [edit]
[-] readpartial-i.ri [edit]
[-] seek-i.ri [edit]
[-] close_read-i.ri [edit]
[-] getpass-i.ri [edit]
[-] nread-i.ri [edit]
[-] tty%3f-i.ri [edit]
[-] pipe-c.ri [edit]
[-] read-c.ri [edit]
[-] sync-i.ri [edit]
[-] cooked-i.ri [edit]
[-] erase_screen-i.ri [edit]
[-] putc-i.ri [edit]
[+] ConsoleMode
[-] to_path-i.ri [edit]
[-] set_encoding-i.ri [edit]
[-] cursor%3d-i.ri [edit]
[-] lineno%3d-i.ri [edit]
[-] close-i.ri [edit]
[-] select-c.ri [edit]
[+] EAGAINWaitWritable
[-] each-i.ri [edit]
[-] fcntl-i.ri [edit]
[-] pos-i.ri [edit]
[-] open-c.ri [edit]
[-] reopen-i.ri [edit]
[+] TimeoutError
[+] EWOULDBLOCKWaitWritable
[-] readline-i.ri [edit]
[-] pid-i.ri [edit]
[-] cursor_right-i.ri [edit]
[-] wait_writable-i.ri [edit]
[-] path-i.ri [edit]
[-] nonblock%3f-i.ri [edit]
[-] readbyte-i.ri [edit]
[-] binmode-i.ri [edit]
[-] ioflush-i.ri [edit]
[-] puts-i.ri [edit]
[-] getbyte-i.ri [edit]
[-] close_on_exec%3d-i.ri [edit]
[-] each_char-i.ri [edit]
[-] wait_priority-i.ri [edit]
[-] goto_column-i.ri [edit]
[-] to_i-i.ri [edit]
[-] check_winsize_changed-i.ri [edit]
[+] WaitReadable
[-] fsync-i.ri [edit]
[-] cursor_down-i.ri [edit]
[-] pos%3d-i.ri [edit]
[-] pread-i.ri [edit]
[-] each_codepoint-i.ri [edit]
[-] pressed%3f-i.ri [edit]
[-] timeout%3d-i.ri [edit]
[-] syswrite-i.ri [edit]
[-] timeout-i.ri [edit]
[-] gets-i.ri [edit]
[-] cursor-i.ri [edit]
[-] ungetbyte-i.ri [edit]
[-] for_fd-c.ri [edit]
[-] ready%3f-i.ri [edit]
[-] winsize%3d-i.ri [edit]
[-] internal_encoding-i.ri [edit]
[-] fdatasync-i.ri [edit]
[-] iflush-i.ri [edit]
[-] popen-c.ri [edit]
[-] binread-c.ri [edit]
[-] read-i.ri [edit]
[-] sysopen-c.ri [edit]
[-] beep-i.ri [edit]
[-] advise-i.ri [edit]
[-] scroll_backward-i.ri [edit]
[-] pathconf-i.ri [edit]
[-] write-i.ri [edit]
[-] console_mode%3d-i.ri [edit]
[-] autoclose%3d-i.ri [edit]
[-] inspect-i.ri [edit]
[+] WaitWritable
[-] close_write-i.ri [edit]
[-] tell-i.ri [edit]
[-] fileno-i.ri [edit]
[-] cursor_left-i.ri [edit]
[+] EWOULDBLOCKWaitReadable
[-] print-i.ri [edit]
[-] foreach-c.ri [edit]
[-] eof%3f-i.ri [edit]
[-] console-c.ri [edit]
[-] to_io-i.ri [edit]
[-] noecho-i.ri [edit]
[+] EAGAINWaitReadable