Module: URI::Escape (Ruby 2.2.3)
Description: Module : URI::Escape - Ruby 2.2.3

- Home
- Core 2.2.3
- Std-lib 2.2.3
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- uri/common.rb

### Methods

- #decode
- #encode
- #escape
- #unescape

### Class/Module Index

Quicksearch

- Kernel
- URI
- URI::BadURIError
- URI::Error
- URI::Escape
- URI::FTP
- URI::Generic
- URI::HTTP
- URI::HTTPS
- URI::InvalidComponentError
- URI::InvalidURIError
- URI::LDAP
- URI::LDAPS
- URI::MailTo
- URI::REGEXP
- URI::RFC2396_Parser
- URI::RFC2396_REGEXP
- URI::RFC2396_REGEXP::PATTERN

No matching classes.

# URI::Escape

module for escaping unsafe characters with codes.

### Public Instance Methods

decode(*arg) click to toggle source
Alias for: unescape
encode(*arg) click to toggle source
Alias for: escape
escape(*arg) click to toggle source

## 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 uri/common.rb, line 97
    def escape(*arg)
      warn "#{caller(1)[0]}: warning: URI.escape is obsolete" if $VERBOSE
      DEFAULT_PARSER.escape(*arg)
    end

Also aliased as: encode
unescape(*arg) click to toggle source

## Synopsis¶ ↑

    URI.unescape(str)

## Args¶ ↑

`str`

  Unescapes the string.

## 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"

                   # File uri/common.rb, line 123
    def unescape(*arg)
      warn "#{caller(1)[0]}: warning: URI.unescape is obsolete" if $VERBOSE
      DEFAULT_PARSER.unescape(*arg)
    end

Also aliased as: decode