third-party/mruby/mrbgems/mruby-io/README.md

   1 mruby-io
   2 ========
   3
   4 `IO` and `File` classes for mruby
   5
   6 ## Installation
   7 Add the line below to your `build_config.rb`:
   8
   9 ```
  10   conf.gem core: 'mruby-io'
  11 ```
  12
  13 ## Implemented methods
  14
  15 ### IO
  16  - http://doc.ruby-lang.org/ja/1.9.3/class/IO.html
  17
  18 | method                     | mruby-io | memo |
  19 | -------------------------  | -------- | ---- |
  20 | IO.binread                 |          |      |
  21 | IO.binwrite                |          |      |
  22 | IO.copy_stream             |          |      |
  23 | IO.new, IO.for_fd, IO.open |  o  |     |
  24 | IO.foreach                 |          |      |
  25 | IO.pipe                    |    o     |      |
  26 | IO.popen                   |    o     |      |
  27 | IO.read                    |    o     |      |
  28 | IO.readlines               |          |      |
  29 | IO.select                  |    o     |      |
  30 | IO.sysopen                 |    o     |      |
  31 | IO.try_convert             |          |      |
  32 | IO.write                   |          |      |
  33 | IO#<<                      |          |      |
  34 | IO#advise                  |          |      |
  35 | IO#autoclose=              |          |      |
  36 | IO#autoclose?              |          |      |
  37 | IO#binmode                 |          |      |
  38 | IO#binmode?                |          |      |
  39 | IO#bytes                   |          | obsolete |
  40 | IO#chars                   |          | obsolete |
  41 | IO#clone, IO#dup           |    o     |      |
  42 | IO#close                   |    o     |      |
  43 | IO#close_on_exec=          |    o     |      |
  44 | IO#close_on_exec?          |    o     |      |
  45 | IO#close_read              |          |      |
  46 | IO#close_write             |          |      |
  47 | IO#closed?                 |    o     |      |
  48 | IO#codepoints              |          | obsolete |
  49 | IO#each_byte               |    o     |      |
  50 | IO#each_char               |    o     |      |
  51 | IO#each_codepoint          |          |      |
  52 | IO#each_line               |    o     |      |
  53 | IO#eof, IO#eof?            |    o     |      |
  54 | IO#external_encoding       |          |      |
  55 | IO#fcntl                   |          |      |
  56 | IO#fdatasync               |          |      |
  57 | IO#fileno, IO#to_i         |    o     |      |
  58 | IO#flush                   |    o     |      |
  59 | IO#fsync                   |          |      |
  60 | IO#getbyte                 |          |      |
  61 | IO#getc                    |    o     |      |
  62 | IO#gets                    |    o     |      |
  63 | IO#internal_encoding       |          |      |
  64 | IO#ioctl                   |          |      |
  65 | IO#isatty, IO#tty?         |    o     |      |
  66 | IO#lineno                  |          |      |
  67 | IO#lineno=                 |          |      |
  68 | IO#lines                   |          | obsolete |
  69 | IO#pid                     |    o     |      |
  70 | IO#pos, IO#tell            |    o     |      |
  71 | IO#pos=                    |    o     |      |
  72 | IO#print                   |    o     |      |
  73 | IO#printf                  |    o     |      |
  74 | IO#putc                    |          |      |
  75 | IO#puts                    |    o     |      |
  76 | IO#read                    |    o     |      |
  77 | IO#read_nonblock           |          |      |
  78 | IO#readbyte                |          |      |
  79 | IO#readchar                |    o     |      |
  80 | IO#readline                |    o     |      |
  81 | IO#readlines               |    o     |      |
  82 | IO#readpartial             |          |      |
  83 | IO#reopen                  |          |      |
  84 | IO#rewind                  |          |      |
  85 | IO#seek                    |    o     |      |
  86 | IO#set_encoding            |          |      |
  87 | IO#stat                    |          |      |
  88 | IO#sync                    |    o     |      |
  89 | IO#sync=                   |    o     |      |
  90 | IO#sysread                 |    o     |      |
  91 | IO#sysseek                 |    o     |      |
  92 | IO#syswrite                |    o     |      |
  93 | IO#to_io                   |          |      |
  94 | IO#ungetbyte               |          |      |
  95 | IO#ungetc                  |    o     |      |
  96 | IO#write                   |    o     |      |
  97 | IO#write_nonblock          |          |      |
  98
  99 ### File
 100  - http://doc.ruby-lang.org/ja/1.9.3/class/File.html
 101
 102 | method                      | mruby-io | memo |
 103 | --------------------------- | -------- | ---- |
 104 | File.absolute_path          |          |      |
 105 | File.atime                  |          |      |
 106 | File.basename               |   o      |      |
 107 | File.blockdev?              |          | FileTest |
 108 | File.chardev?               |          | FileTest |
 109 | File.chmod                  |   o      |      |
 110 | File.chown                  |          |      |
 111 | File.ctime                  |          |      |
 112 | File.delete, File.unlink    |   o      |      |
 113 | File.directory?             |   o      | FileTest |
 114 | File.dirname                |   o      |      |
 115 | File.executable?            |          | FileTest |
 116 | File.executable_real?       |          | FileTest |
 117 | File.exist?, exists?        |   o      | FileTest |
 118 | File.expand_path            |   o      |      |
 119 | File.extname                |   o      |      |
 120 | File.file?                  |   o      | FileTest |
 121 | File.fnmatch, File.fnmatch? |          |      |
 122 | File.ftype                  |          |      |
 123 | File.grpowned?              |          | FileTest |
 124 | File.identical?             |          | FileTest |
 125 | File.join                   |   o      |      |
 126 | File.lchmod                 |          |      |
 127 | File.lchown                 |          |      |
 128 | File.link                   |          |      |
 129 | File.lstat                  |          |      |
 130 | File.mtime                  |          |      |
 131 | File.new, File.open         |   o      |      |
 132 | File.owned?                 |          | FileTest |
 133 | File.path                   |          |      |
 134 | File.pipe?                  |   o      | FileTest |
 135 | File.readable?              |          | FileTest |
 136 | File.readable_real?         |          | FileTest |
 137 | File.readlink               |   o      |      |
 138 | File.realdirpath            |          |      |
 139 | File.realpath               |   o      |      |
 140 | File.rename                 |   o      |      |
 141 | File.setgid?                |          | FileTest |
 142 | File.setuid?                |          | FileTest |
 143 | File.size                   |   o      |      |
 144 | File.size?                  |   o      | FileTest |
 145 | File.socket?                |   o      | FileTest |
 146 | File.split                  |          |      |
 147 | File.stat                   |          |      |
 148 | File.sticky?                |          | FileTest |
 149 | File.symlink                |          |      |
 150 | File.symlink?               |   o      | FileTest |
 151 | File.truncate               |          |      |
 152 | File.umask                  |   o      |      |
 153 | File.utime                  |          |      |
 154 | File.world_readable?        |          |      |
 155 | File.world_writable?        |          |      |
 156 | File.writable?              |          | FileTest |
 157 | File.writable_real?         |          | FileTest |
 158 | File.zero?                  |   o      | FileTest |
 159 | File#atime                  |          |      |
 160 | File#chmod                  |          |      |
 161 | File#chown                  |          |      |
 162 | File#ctime                  |          |      |
 163 | File#flock                  |   o      |      |
 164 | File#lstat                  |          |      |
 165 | File#mtime                  |          |      |
 166 | File#path, File#to_path     |   o      |      |
 167 | File#size                   |          |      |
 168 | File#truncate               |          |      |
 169
 170
 171 ## License
 172
 173 Copyright (c) 2013 Internet Initiative Japan Inc.
 174 Copyright (c) 2017 mruby developers
 175
 176 Permission is hereby granted, free of charge, to any person obtaining a
 177 copy of this software and associated documentation files (the "Software"),
 178 to deal in the Software without restriction, including without limitation
 179 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 180 and/or sell copies of the Software, and to permit persons to whom the
 181 Software is furnished to do so, subject to the following conditions:
 182
 183 The above copyright notice and this permission notice shall be included in
 184 all copies or substantial portions of the Software.
 185
 186 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 187 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 188 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 189 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 190 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 191 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 192 DEALINGS IN THE SOFTWARE.