123456789_123456789_123456789_123456789_123456789_

Module: URI::Escape

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Extended In:
::URI
Defined in: lib/uri/common.rb

Overview

module for escaping unsafe characters with codes.

Instance Method Summary

Instance Method Details

#decode(*arg)

Alias for #unescape.

[ GitHub ] 

  


# File 'lib/uri/common.rb', line 138



alias decode unescape


  








  

    #encode(*arg)  
  



  

    

Alias for #escape.


  



  [ GitHub ]


  

  


# File 'lib/uri/common.rb', line 106



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 UNSAFE. When this argument is a String, it represents a character set.





Description



Escapes the string, replacing all unsafe characters with codes.



This method is obsolete and should not be used. Instead, use CGI.escape, URI.encode_www_form or URI.encode_www_form_component depending on your specific use case.



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"


  



  [ GitHub ]


  

  


# File 'lib/uri/common.rb', line 102



def escape(*arg)
  warn "URI.escape is obsolete", uplevel: 1 if $VERBOSE
  DEFAULT_PARSER.escape(*arg)
end


  








  

    #unescape(*arg)  
    Also known as: #decode
  



  

    

Synopsis



URI.unescape(str)



Args


str



Unescapes the string.





Description



This method is obsolete and should not be used. Instead, use CGI.unescape, URI.decode_www_form or URI.decode_www_form_component depending on your specific use case.



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"


  



  [ GitHub ]


  

  


# File 'lib/uri/common.rb', line 134



def unescape(*arg)
  warn "URI.unescape is obsolete", uplevel: 1 if $VERBOSE
  DEFAULT_PARSER.unescape(*arg)
end