Module: URI::Escape
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Extended In:
| |
Defined in: | lib/uri/common.rb |
Overview
module for escaping unsafe characters with codes.
Instance Method Summary
-
#decode(*arg)
Alias for #unescape.
-
#encode(*arg)
Alias for #escape.
-
#escape(*arg)
(also: #encode)
Synopsis.
-
#unescape(*arg)
(also: #decode)
Synopsis.
Instance Method Details
#decode(*arg)
Alias for #unescape.
# File 'lib/uri/common.rb', line 128
alias decode unescape
#encode(*arg)
Alias for #escape.
# File 'lib/uri/common.rb', line 102
alias encode escape
#escape(*arg) Also known as: #encode
Synopsis
URI.escape(str [, unsafe])
Args
str
-
String to replaces in.
unsafe
-
Regexp that matches all symbols that must be replaced with codes. By default uses
REGEXP::UNSAFE
. When this argument is a String, it represents a character set.
Description
Escapes the string, replacing all unsafe characters with codes.
Usage
require 'uri'
enc_uri = URI.escape("http://example.com/?a=\11\15")
p enc_uri
# => "http://example.com/?a=%09%0D"
p URI.unescape(enc_uri)
# => "http://example.com/?a=\t\r"
p URI.escape("@?@!", "!?")
# => "@%3F@%21"
# File 'lib/uri/common.rb', line 98
def escape(*arg) warn "#{caller(1)[0]}: warning: URI.escape is obsolete" if $VERBOSE DEFAULT_PARSER.escape(*arg) end
#unescape(*arg) Also known as: #decode
# File 'lib/uri/common.rb', line 124
def unescape(*arg) warn "#{caller(1)[0]}: warning: URI.unescape is obsolete" if $VERBOSE DEFAULT_PARSER.unescape(*arg) end