struct URI::Params
Overview
An ordered multi-value mapped collection representing generic URI parameters.
Defined in:
uri/params.crConstructors
- .new(raw_params : Hash(String, Array(String)))
-
.new
Returns an empty
URI::Params
. -
.parse(query : String) : self
Parses an URI query string into a
URI::Params
Class Method Summary
-
.build(io : IO, *, space_to_plus : Bool = true, & : Builder -> ) : Nil
Builds an url-encoded URI form/query.
-
.build(*, space_to_plus : Bool = true, &block : Builder -> ) : String
Builds an url-encoded URI form/query.
-
.encode(io : IO, hash : Hash(String, String | Array(String))) : Nil
Appends the given key value pairs as a url-encoded URI form/query to the given
io
. -
.encode(io : IO, named_tuple : NamedTuple) : Nil
Appends the given key value pairs as a url-encoded URI form/query to the given
io
. -
.encode(hash : Hash(String, String | Array(String))) : String
Returns the given key value pairs as a url-encoded URI form/query.
-
.encode(named_tuple : NamedTuple) : String
Returns the given key value pairs as a url-encoded URI form/query.
-
.parse(query : String, &)
Parses an URI query and yields each key-value pair.
Instance Method Summary
- #==(other : self)
-
#[](name) : String
Returns first value for specified param name.
-
#[]=(name, value : String | Array(String))
Sets the name key to value.
-
#[]?(name) : String | Nil
Returns first value or
nil
for specified param name. -
#add(name, value)
Appends new value for specified param name.
-
#clone : self
Returns a copy of this
URI::Params
instance. -
#delete(name) : String
Deletes first value for provided param name.
-
#delete_all(name) : Array(String) | Nil
Deletes all values for provided param name.
-
#dup : self
Returns a copy of this
URI::Params
instance. -
#each(&)
Allows to iterate over all name-value pairs.
-
#empty?(*args, **options)
Returns
true
if params is empty. -
#empty?(*args, **options, &)
Returns
true
if params is empty. -
#fetch(name, default)
Returns first value for specified param name.
-
#fetch(name, &)
Returns first value for specified param name.
-
#fetch_all(name) : Array(String)
Returns all values for specified param name.
-
#has_key?(*args, **options)
Returns
true
if param with provided name exists. -
#has_key?(*args, **options, &)
Returns
true
if param with provided name exists. - #hash(hasher)
-
#inspect(io : IO)
Appends this struct's name and instance variables names and values to the given IO.
-
#merge(params : URI::Params, *, replace : Bool = true) : URI::Params
Merges params and self into a new instance.
-
#merge!(params : URI::Params, *, replace : Bool = true) : URI::Params
Merges params into self.
-
#set_all(name, values)
Sets all values for specified param name at once.
-
#to_s(io : IO, *, space_to_plus : Bool = true) : Nil
Serializes to string representation as http url-encoded form.
-
#to_s(*, space_to_plus : Bool = true)
Serializes to string representation as http url-encoded form.
Instance methods inherited from struct Struct
==(other) : Bool
==,
hash(hasher)
hash,
inspect(io : IO) : Nil
inspect,
pretty_print(pp) : Nil
pretty_print,
to_s(io : IO) : Nil
to_s
Instance methods inherited from struct Value
==(other : JSON::Any)==(other : YAML::Any)
==(other) ==, dup dup
Instance methods inherited from class Object
! : Bool
!,
!=(other)
!=,
!~(other)
!~,
==(other)
==,
===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message)
not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as
Class methods inherited from class Object
from_json(string_or_io, root : String)from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml
Macros inherited from class Object
class_getter(*names, &block)
class_getter,
class_getter!(*names)
class_getter!,
class_getter?(*names, &block)
class_getter?,
class_property(*names, &block)
class_property,
class_property!(*names)
class_property!,
class_property?(*names, &block)
class_property?,
class_setter(*names)
class_setter,
def_clone
def_clone,
def_equals(*fields)
def_equals,
def_equals_and_hash(*fields)
def_equals_and_hash,
def_hash(*fields)
def_hash,
delegate(*methods, to object)
delegate,
forward_missing_to(delegate)
forward_missing_to,
getter(*names, &block)
getter,
getter!(*names)
getter!,
getter?(*names, &block)
getter?,
property(*names, &block)
property,
property!(*names)
property!,
property?(*names, &block)
property?,
setter(*names)
setter
Constructor Detail
Parses an URI query string into a URI::Params
require "uri/params"
URI::Params.parse("foo=bar&foo=baz&qux=zoo")
# => #<URI::Params @raw_params = {"foo" => ["bar", "baz"], "qux" => ["zoo"]}>
Class Method Detail
Builds an url-encoded URI form/query.
The yielded object has an #add
method that accepts two arguments,
a key (String
) and a value (String
or Nil
).
Keys and values are escaped using URI.encode_www_form
.
require "uri/params"
params = URI::Params.build do |form|
form.add "color", "black"
form.add "name", "crystal"
form.add "year", "2012 - today"
end
params # => "color=black&name=crystal&year=2012+-+today"
By default spaces are outputted as +
.
If space_to_plus is false
then they are outputted as %20
:
require "uri/params"
params = URI::Params.build(space_to_plus: false) do |form|
form.add "year", "2012 - today"
end
params # => "year=2012%20-%20today"
Builds an url-encoded URI form/query.
The yielded object has an #add
method that accepts two arguments,
a key (String
) and a value (String
or Nil
).
Keys and values are escaped using URI.encode_www_form
.
require "uri/params"
params = URI::Params.build do |form|
form.add "color", "black"
form.add "name", "crystal"
form.add "year", "2012 - today"
end
params # => "color=black&name=crystal&year=2012+-+today"
By default spaces are outputted as +
.
If space_to_plus is false
then they are outputted as %20
:
require "uri/params"
params = URI::Params.build(space_to_plus: false) do |form|
form.add "year", "2012 - today"
end
params # => "year=2012%20-%20today"
Appends the given key value pairs as a url-encoded URI form/query to the given io
.
require "uri/params"
io = IO::Memory.new
URI::Params.encode(io, {"foo" => "bar", "baz" => ["quux", "quuz"]})
io.to_s # => "foo=bar&baz=quux&baz=quuz"
Appends the given key value pairs as a url-encoded URI form/query to the given io
.
require "uri/params"
io = IO::Memory.new
URI::Params.encode(io, {foo: "bar", baz: ["quux", "quuz"]})
io.to_s # => "foo=bar&baz=quux&baz=quuz"
Returns the given key value pairs as a url-encoded URI form/query.
require "uri/params"
URI::Params.encode({"foo" => "bar", "baz" => ["quux", "quuz"]}) # => "foo=bar&baz=quux&baz=quuz"
Returns the given key value pairs as a url-encoded URI form/query.
require "uri/params"
URI::Params.encode({foo: "bar", baz: ["quux", "quuz"]}) # => "foo=bar&baz=quux&baz=quuz"
Parses an URI query and yields each key-value pair.
require "uri/params"
query = "foo=bar&foo=baz&qux=zoo"
URI::Params.parse(query) do |key, value|
# ...
end
Instance Method Detail
Returns first value for specified param name.
require "uri/params"
params = URI::Params.parse("email=john@example.org")
params["email"] # => "john@example.org"
params["non_existent_param"] # KeyError
Sets the name key to value.
require "uri/params"
params = URI::Params{"a" => ["b", "c"]}
params["a"] = "d"
params["a"] # => "d"
params.fetch_all("a") # => ["d"]
params["a"] = ["e", "f"]
params["a"] # => "e"
params.fetch_all("a") # => ["e", "f"]
Returns first value or nil
for specified param name.
params["email"]? # => "john@example.org"
params["non_existent_param"]? # nil
Appends new value for specified param name. Creates param when there was no such param.
params.add("item", "keychain")
params.fetch_all("item") # => ["pencil", "book", "workbook", "keychain"]
Returns a copy of this URI::Params
instance.
require "uri/params"
original = URI::Params{"name" => "Jamie"}
updated = original.clone
updated["name"] = "Ary"
original["name"] # => "Jamie"
Identical to #dup
.
Deletes first value for provided param name. If there are no values left, deletes param itself. Returns deleted value.
params.delete("item") # => "keychain"
params.fetch_all("item") # => ["keynote"]
params.delete("item") # => "keynote"
params["item"] # KeyError
params.delete("non_existent_param") # KeyError
Deletes all values for provided param name. Returns array of deleted values.
params.set_all("comments", ["hello, world!", ":+1:"])
params.delete_all("comments") # => ["hello, world!", ":+1:"]
params.has_key?("comments") # => false
Returns a copy of this URI::Params
instance.
require "uri/params"
original = URI::Params{"name" => "Jamie"}
updated = original.dup
updated["name"] = "Ary"
original["name"] # => "Jamie"
Identical to #clone
.
Allows to iterate over all name-value pairs.
params.each do |name, value|
puts "#{name} => #{value}"
end
# Outputs:
# email => john@example.org
# item => keychain
# item => keynote
Returns true
if params is empty.
URI::Params.new.empty? # => true
URI::Params.parse("foo=bar&foo=baz&qux=zoo").empty? # => false
Returns true
if params is empty.
URI::Params.new.empty? # => true
URI::Params.parse("foo=bar&foo=baz&qux=zoo").empty? # => false
Returns first value for specified param name. Falls back to provided default value when there is no such param.
params["email"] = "john@example.org"
params.fetch("email", "none@example.org") # => "john@example.org"
params.fetch("non_existent_param", "default value") # => "default value"
Returns first value for specified param name. Falls back to return value of provided block when there is no such param.
params.delete("email")
params.fetch("email") { raise "Email is missing" } # raises "Email is missing"
params.fetch("non_existent_param") { "default computed value" } # => "default computed value"
Returns all values for specified param name.
params.set_all("item", ["pencil", "book", "workbook"])
params.fetch_all("item") # => ["pencil", "book", "workbook"]
Returns true
if param with provided name exists.
params.has_key?("email") # => true
params.has_key?("garbage") # => false
Returns true
if param with provided name exists.
params.has_key?("email") # => true
params.has_key?("garbage") # => false
Appends this struct's name and instance variables names and values to the given IO.
struct Point
def initialize(@x : Int32, @y : Int32)
end
end
p1 = Point.new 1, 2
p1.to_s # "Point(@x=1, @y=2)"
p1.inspect # "Point(@x=1, @y=2)"
Merges params and self into a new instance.
If replace is false
values with the same key are concatenated.
Otherwise the value in params overrides the one in self.
params = URI::Params.parse("foo=bar&foo=baz&qux=zoo")
other_params = URI::Params.parse("foo=buzz&foo=extra")
params.merge(other_params).to_s # => "foo=buzz&foo=extra&qux=zoo"
params.merge(other_params, replace: false).to_s # => "foo=bar&foo=baz&foo=buzz&foo=extra&qux=zoo"
See #merge!
for a mutating alternative
Merges params into self.
params = URI::Params.parse("foo=bar&foo=baz&qux=zoo")
other_params = URI::Params.parse("foo=buzz&foo=extra")
params.merge!(other_params).to_s # => "foo=buzz&foo=extra&qux=zoo"
params.fetch_all("foo") # => ["buzz", "extra"]
See #merge
for a non-mutating alternative
Sets all values for specified param name at once.
params.set_all("item", ["keychain", "keynote"])
params.fetch_all("item") # => ["keychain", "keynote"]
Serializes to string representation as http url-encoded form.
require "uri/params"
params = URI::Params.parse("item=keychain&greeting=hello+world&email=john@example.org")
params.to_s # => "item=keychain&greeting=hello+world&email=john%40example.org"
By default spaces are outputted as +
.
If space_to_plus is false
then they are outputted as %20
:
require "uri/params"
params = URI::Params.parse("item=keychain&greeting=hello+world&email=john@example.org")
params.to_s(space_to_plus: false) # => "item=keychain&greeting=hello%20world&email=john%40example.org"
Serializes to string representation as http url-encoded form.
require "uri/params"
params = URI::Params.parse("item=keychain&greeting=hello+world&email=john@example.org")
params.to_s # => "item=keychain&greeting=hello+world&email=john%40example.org"
By default spaces are outputted as +
.
If space_to_plus is false
then they are outputted as %20
:
require "uri/params"
params = URI::Params.parse("item=keychain&greeting=hello+world&email=john@example.org")
params.to_s(space_to_plus: false) # => "item=keychain&greeting=hello%20world&email=john%40example.org"