kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

[ruby/io-wait] Document mandatory require for using io/wait methods

Browse source 
2beb05bd48
This commit is contained in:
apatniv 2022-01-23 21:31:29 -05:00 • committed by git
parent c6a19b77a2
commit e7b573e576
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
ext/io/wait/wait.c
View file

@ -77,6 +77,8 @@ wait_for_single_fd(rb_io_t *fptr, int events, struct timeval *tv)
*
* Returns number of bytes that can be read without blocking.
* Returns zero if no information available.
*
* You must require 'io/wait' to use this method.
*/
static VALUE
@ -122,6 +124,8 @@ io_wait_event(VALUE io, int event, VALUE timeout)
* io.ready? -> true or false
*
* Returns +true+ if input available without blocking, or +false+.
*
* You must require 'io/wait' to use this method.
*/
static VALUE
@ -154,6 +158,8 @@ io_ready_p(VALUE io)
* Waits until IO is readable and returns +true+, or
* +false+ when times out.
* Returns +true+ immediately when buffered data is available.
*
* You must require 'io/wait' to use this method.
*/
static VALUE
@ -193,6 +199,8 @@ io_wait_readable(int argc, VALUE *argv, VALUE io)
*
* Waits until IO is writable and returns +true+ or
* +false+ when times out.
*
* You must require 'io/wait' to use this method.
*/
static VALUE
io_wait_writable(int argc, VALUE *argv, VALUE io)
@ -228,6 +236,8 @@ io_wait_writable(int argc, VALUE *argv, VALUE io)
*
* Waits until IO is priority and returns +true+ or
* +false+ when times out.
*
* You must require 'io/wait' to use this method.
*/
static VALUE
io_wait_priority(int argc, VALUE *argv, VALUE io)
@ -295,6 +305,8 @@ wait_mode_sym(VALUE mode)
*
* Optional parameter +mode+ is one of +:read+, +:write+, or
* +:read_write+.
*
* You must require 'io/wait' to use this method.
*/
static VALUE