module URI::Params::Serializable

Overview

Including this module will make an object serializable to and from HTTP params query. It adds a .from_query(query : String) and #to_query : String methods.

Defined in:

http-params-serializable.cr
http-params-serializable/annotations.cr
http-params-serializable/errors.cr

Class Method Summary

Instance Method Summary

Class Method Detail

def self.build_path(path : Array(String)) : String #

Build query path from an array of path elements.

build_path(["foo", "bar", ""]) # => "foo[bar][]"

[View source]
def self.build_path(*path : *T) : String forall T #

Build query path from a tuple of path elements.

build_path("foo", "bar", "") # => "foo[bar][]"

[View source]
def self.split_path(path : String) : Array(String) #

Split query path into path elements.

"foo[bar][]".split # => ["foo", "bar", ""]

[View source]

Instance Method Detail

def to_http_param(builder : Builder, key : String? = nil) #

Serialalize self into an HTTP params query with the builder at key. See #to_query for instance variable rules.


[View source]
def to_query : String #

Serialalize self into an HTTP params query, returning a String. Instance variables are by default seralized under camelCased keys, unless explicitly specified with @[HTTP::Param(key: "mykey").


[View source]