lib/bencode.rb in bencode_blatyo-1.0.0 vs lib/bencode.rb in bencode_blatyo-1.0.1
- old
+ new
@@ -14,41 +14,41 @@
class << self
# This method decodes a bencoded string.
#
# BEncode.decode("6:string") #=> "string"
#
- # @param [String] string the bencoded string to decode
- # @return [String, Integer, Hash, Array] the decoded object
+ # @param [::String] string the bencoded string to decode
+ # @return [::String, ::Integer, ::Hash, ::Array] the decoded object
def decode(string)
scanner = StringScanner.new(string)
Parser.parse_object(scanner) or raise BEncodeError, "Invalid bencoding"
end
# This method decodes a bencoded file.
#
# BEncode.decode_file("simple.torrent") #=> "d8:announce32:http://www..."
#
- # @param [String] file the file to decode
- # @return [String, Integer, Hash, Array] the decoded object
+ # @param [::String] file the file to decode
+ # @return [::String, ::Integer, ::Hash, ::Array] the decoded object
def decode_file(file)
decode(File.open(file, 'rb') {|f| f.read})
end
# This method encodes a bencoded object.
#
# BEncode.encode("string") #=> "6:string"
#
# @param [#bencode] object the object to encode
- # @return [String] the bencoded object
+ # @return [::String] the bencoded object
def encode(object)
object.bencode
end
# This method encodes a bencoded object.
#
# BEncode.encode("string") #=> "6:string"
#
- # @param [String] file the file to write the bencoded object to
+ # @param [::String] file the file to write the bencoded object to
# @param [#bencode] object the object to encode
def encode_file(file, object)
File.open(file, 'wb') {|f| f.write encode(object)}
end
end
\ No newline at end of file