Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add IO#set_encoding_by_bom since 2.7.0 #2275

Merged
merged 1 commit into from
May 26, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions refm/api/src/_builtin/IO
Original file line number Diff line number Diff line change
Expand Up @@ -2247,6 +2247,32 @@ opt のハッシュで外部エンコーディングを内部エンコーディ
io = File.open(file)
io.set_encoding("ASCII-8BIT", "EUC-JP")

#@since 2.7.0
--- set_encoding_by_bom -> Encoding | nil

BOM から IO のエンコーディングを設定します。

自身が BOM から始まる場合、BOM を読み進めて外部エンコーディングをセットし、セットしたエンコーディングを返します。
BOM が見つからなかった場合は nil を返します。

自身がバイナリモードでないかすでにエンコーディングがセットされている場合、例外が発生します。
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

実際にはArgumentErrorが発生するようですが、RDocの方に例外クラスが明示されていなかったので、るりまでもクラスは書かないようにしています


#@samplecode 例
File.write("bom.txt", "\u{FEFF}abc")
File.open("bom.txt", "rb") do |io|
p io.set_encoding_by_bom #=> #<Encoding:UTF-8>
str = io.read
p str #=> "abc"
p str.encoding #=> #<Encoding:UTF-8>
end

File.write("nobom.txt", "abc")
File.open("nobom.txt", "rb") do |io|
p io.set_encoding_by_bom #=> nil
end
#@end
#@end

--- autoclose=(bool)

auto-close フラグを設定します。
Expand Down