diff options
author | David RodrÃguez <deivid.rodriguez@riseup.net> | 2022-05-20 10:23:45 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-20 17:23:45 +0900 |
commit | ec7b42eb774222b31f6621413d3b7714f049cfb2 (patch) | |
tree | 02fdaabc6d9de34e84318ae1021fe9e4bb988479 | |
parent | 6850e3c42ec85c49cc359539ca5f37831935ae74 (diff) | |
download | ruby-ec7b42eb774222b31f6621413d3b7714f049cfb2.tar.gz |
[DOC] Add a note to clarify binary flags to `IO.new`
Try to make it more clear that the `File::BINARY` integer flag, and the
`b` string suffix are not equivalent.
-rw-r--r-- | io.c | 8 |
1 files changed, 7 insertions, 1 deletions
@@ -14212,7 +14212,7 @@ set_LAST_READ_LINE(VALUE val, ID _x, VALUE *_y) * ==== Read/Write Mode Specified as an \Integer * * When +mode+ is an integer it must be one or more (combined by bitwise OR (<tt>|</tt>) - * of the modes defined in File::Constants: + * of the following modes: * * - +File::RDONLY+: Open for reading only. * - +File::WRONLY+: Open for writing only. @@ -14277,6 +14277,12 @@ set_LAST_READ_LINE(VALUE val, ID _x, VALUE *_y) * * File.open('t.tmp', 'wx') * + * Note that when using integer flags to set the read/write mode, it's not + * possible to also set the binary data mode by adding the File::BINARY flag + * to the bitwise OR combination of integer flags. This is because, as + * documented in File::Constants, the File::BINARY flag only disables line code + * conversion, but does not change the external encoding at all. + * * == Encodings * * Any of the string modes above may specify encodings -- |