struct URI::Params
Overview
An ordered multi-value mapped collection representing generic URI parameters.
Included Modules
- Enumerable({String, String})
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(&block : Builder -> ) : String
Builds an url-encoded URI form/query.
-
.encode(hash : Hash(String, String | Array(String)))
Returns the given key value pairs as a url-encoded URI form/query.
-
.encode(named_tuple : NamedTuple)
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)
Returns first value for specified param name.
-
#[]=(name, value : String | Array(String))
Sets the name key to value.
-
#[]?(name)
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)
Deletes first value for provided param name.
-
#delete_all(name)
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)
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)
-
#set_all(name, values)
Sets all values for specified param name at once.
-
#to_s(io : IO) : Nil
Serializes to string representation as http url-encoded form.
Instance methods inherited from module Enumerable({String, String})
all?(&)all?(pattern)
all? all?, any?(&)
any?(pattern)
any? any?, chunks(&block : {String, String} -> U) forall U chunks, compact_map(&) compact_map, count(&)
count(item) count, cycle(&)
cycle(n, &) cycle, each(&block : {String, String} -> _) each, each_cons(count : Int, reuse = false, &) each_cons, each_cons_pair(& : {String, String}, {String, String} -> _) : Nil each_cons_pair, each_slice(count : Int, reuse = false, &) each_slice, each_with_index(offset = 0, &) each_with_index, each_with_object(obj, &) each_with_object, empty? empty?, find(if_none = nil, &) find, first(&)
first(count : Int)
first first, first? first?, flat_map(&block : {String, String} -> _) flat_map, group_by(&block : {String, String} -> U) forall U group_by, in_groups_of(size : Int, filled_up_with : U = nil) forall U
in_groups_of(size : Int, filled_up_with : U = nil, reuse = false, &) forall U in_groups_of, includes?(obj) includes?, index(&)
index(obj) index, index_by(&block : {String, String} -> U) forall U index_by, join(separator = "", & : {String, String} -> )
join(separator, io : IO, &)
join(io : IO, separator = "", & : {String, String}, IO -> )
join(separator = "")
join(separator, io : IO)
join(io : IO, separator = "") join, map(&block : {String, String} -> U) forall U map, map_with_index(offset = 0, &block : {String, String}, Int32 -> U) forall U map_with_index, max max, max? max?, max_by(&block : {String, String} -> U) forall U max_by, max_by?(&block : {String, String} -> U) forall U max_by?, max_of(&block : {String, String} -> U) forall U max_of, max_of?(&block : {String, String} -> U) forall U max_of?, min min, min? min?, min_by(&block : {String, String} -> U) forall U min_by, min_by?(&block : {String, String} -> U) forall U min_by?, min_of(&block : {String, String} -> U) forall U min_of, min_of?(&block : {String, String} -> U) forall U min_of?, minmax minmax, minmax? minmax?, minmax_by(&block : {String, String} -> U) forall U minmax_by, minmax_by?(&block : {String, String} -> U) forall U minmax_by?, minmax_of(&block : {String, String} -> U) forall U minmax_of, minmax_of?(&block : {String, String} -> U) forall U minmax_of?, none?(pattern)
none?(&)
none? none?, one?(&)
one?(pattern)
one? one?, partition(&) partition, product(initial : Number)
product
product(initial : Number, &)
product(&) product, reduce(memo, &)
reduce(&) reduce, reduce?(&) reduce?, reject(pattern)
reject(type : U.class) forall U
reject(&block : {String, String} -> ) reject, sample(n : Int, random = Random::DEFAULT)
sample(random = Random::DEFAULT) sample, select(pattern)
select(type : U.class) forall U
select(&block : {String, String} -> ) select, size size, skip(count : Int) skip, skip_while(&) skip_while, sum(initial)
sum
sum(initial, &)
sum(&) sum, take_while(&) take_while, tally : Hash({String, String}, Int32) tally, to_a to_a, to_h
to_h(&block : {String, String} -> Tuple(K, V)) forall K, V to_h, to_set to_set, zip(*others : Indexable | Iterable | Iterator, &)
zip(*others : Indexable | Iterable | Iterator) zip, zip?(*others : Indexable | Iterable | Iterator, &)
zip?(*others : Indexable | Iterable | Iterator) zip?
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?(*values : Object) : Bool
in?(collection) : Bool in?, inspect : String
inspect(io : IO) : Nil inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, 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)
to_json to_json, to_pretty_json(io : IO, indent : String = " ")
to_pretty_json(indent : String = " ") to_pretty_json, to_s : String
to_s(io : IO) : Nil to_s, to_yaml(io : IO)
to_yaml 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
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"
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
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&item=keynote&email=john@example.org")
params.to_s # => "item=keychain&item=keynote&email=john%40example.org"