Index: refm/api/src/_builtin/String =================================================================== --- refm/api/src/_builtin/String (revision 2421) +++ refm/api/src/_builtin/String (working copy) @@ -111,11 +111,14 @@ #@since 1.9.0 --- try_convert(obj) -> String | nil -#@todo -Try to convert obj into a String, using to_str method. Returns -converted regexp or nil if obj cannot be converted for any reason. +obj を String に変換しようと試みます。変換には [[m:Object#to_str]] メソッ +ドが使われます。変換後の文字列を返すか、何らかの理由により変換できなかっ +た場合は nil が返されます。 +@param obj 変換する任意のオブジェクト +@return 変換後の文字列または nil + String.try_convert("str") # => str String.try_convert(/re/) # => nil @@ -1354,7 +1357,12 @@ --- length -> Integer --- size -> Integer +#@since 1.9.0 +文字列の文字数を返します。バイト数を知りたいときは bytesize メソッドを使ってください。 +@see [[m:String#bytesize]] +#@else 文字列のバイト数を返します。 +#@end #@if (version >= "1.8.0") #@since 1.9.0 @@ -2573,28 +2581,69 @@ #@end #@since 1.9.0 ---- bytesize -#@todo +--- bytesize -> Fixnum +文字列のバイト長を返します。 +@see [[m:String#size]] + --- each_char {|cstr| block } -> String -#@todo -Passes each character in str to the given block. +文字列のそれぞれの文字をブロックに渡して実行します。 +@return self + +たとえば、 "hello".each_char {|c| print c, ' ' } - -produces: - +は次のように出力されます。 h e l l o --- encoding -> Encoding -#@todo -Returns the Encoding object that represents the encoding of obj. +文字列のエンコーディング情報を表現した Encoding オブジェクトを返します。 +@see [[c:Encoding]] --- force_encoding(encoding) -> String -#@todo -Changes the encoding to encoding and returns self. +文字列のエンコーディングを encoding に変更します。 +@param encoding 変更するエンコーディング情報 +@return self +--- ascii_only? -> true | false + +文字列がASCII文字のみで構成されている場合に true を返します。さもなくば +false を返します。 +@return true または false + +--- valid_encoding? -> true | false + +文字列の内容が、現在のエンコーディングに照らしあわせて妥当であれば +true を返します。さもなくば false を返します。 +@return true または false + +--- encode(encoding) -> String +--- encode(encoding, from_encoding) -> String + +self を指定したエンコーディングに変換した文字列を作成して返します。引数 +を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな +くば self のエンコーディングが使われます。 + +@param encoding 変換先のエンコーディング +@param from_encoding 変換元のエンコーディング +@return 変換された文字列 +@see [[m:String#encode!]] + +--- encode!(encoding) -> String +--- encode!(encoding, from_encoding) -> String + +self を指定したエンコーディングに変換し、自身を置き換えます。引数を2つ +与えた場合、第二引数は変換元のエンコーディングを意味します。さもなくば +self のエンコーディングが使われます。変換後の self を返します。 + +(gsub!などと異なり)変換が行なわれなくても self を返します。 + +@param encoding 変換先のエンコーディング +@param from_encoding 変換元のエンコーディング +@return 変換後のself +@see [[m:String#encode]] + #@end