qs_adv

Types

Config

pub type Config {
  Config(fail_on_invalid: Bool, scheme: Scheme)
}

Constructors

Config(fail_on_invalid: Bool, scheme: Scheme)

OneOrMany

</>

pub type OneOrMany {
  One(String)
  Many(List(String))
}

Constructors

```
One(String)
```
```
Many(List(String))
```

QueryAdv

</>

pub type QueryAdv =
  qs.Query(OneOrMany)

Scheme

</>

pub type Scheme {
  SchemeListAsMultipleValues(list_suffix: String)
  SchemeListAsSingleValue(list_suffix: String, separator: String)
}

Constructors

SchemeListAsMultipleValues(list_suffix: String)

SchemeListAsSingleValue(list_suffix: String, separator: String)

Functions

default_config

</>

pub fn default_config() -> Config

default_parse

</>

pub fn default_parse(
  qs: String,
) -> Result(Dict(String, OneOrMany), String)

Parse a query string

Example

"?color=red&tags[]=large&tags[]=wool"
|> qs.default_parse

==

Ok(
  dict.from_list(
    [ #("color", One("red")), #("tags", Many(["large", "wool"])) ]
  )
)

default_serialize

</>

pub fn default_serialize(
  query: Dict(String, OneOrMany),
) -> String

Serialize a query

Example

[ #("color", One("red")), #("tags", Many(["large", "wool"])) ]
|> qs.serialize

==

"?color=red&tags[]=large&tags[]=wool"

delete

</>

pub fn delete(
  query: Dict(String, OneOrMany),
  key: String,
) -> Dict(String, OneOrMany)

empty

</>

pub fn empty() -> Dict(String, OneOrMany)

get

</>

pub fn get(
  query: Dict(String, OneOrMany),
  key: String,
) -> Result(OneOrMany, String)

get_as_bool

</>

pub fn get_as_bool(
  query: Dict(String, OneOrMany),
  key: String,
) -> Result(Bool, String)

Attempt to get one value as a Bool. If the value is a list this fails. If the value cannot be parsed to a Bool this fails.

get_as_float

</>

pub fn get_as_float(
  query: Dict(String, OneOrMany),
  key: String,
) -> Result(Float, String)

Attempt to get one value as an Float. If the value is a list this fail.

get_as_int

</>

pub fn get_as_int(
  query: Dict(String, OneOrMany),
  key: String,
) -> Result(Int, String)

Attempt to get one value as an Int. If the value is a list this fails. If the value cannot be parsed to an Int this fails.

get_as_list

</>

pub fn get_as_list(
  query: Dict(String, OneOrMany),
  key: String,
) -> List(String)

Get values from the query as a list of strings (regardless if one or many). If key is not present this defaults to an empty list.

get_as_list_of_bool

</>

pub fn get_as_list_of_bool(
  query: Dict(String, OneOrMany),
  key: String,
) -> Result(List(Bool), String)

Attempt to get values as a list of Bool.

get_as_list_of_float

</>

pub fn get_as_list_of_float(
  query: Dict(String, OneOrMany),
  key: String,
) -> Result(List(Float), String)

Attempt to get values as a list of Float.

get_as_list_of_int

</>

pub fn get_as_list_of_int(
  query: Dict(String, OneOrMany),
  key: String,
) -> Result(List(Int), String)

Attempt to get values as a list of Int.

get_as_string

</>

pub fn get_as_string(
  query: Dict(String, OneOrMany),
  key: String,
) -> Result(String, String)

Attempt to get one value as a String. If the value is a list this fails.

has_key

</>

pub fn has_key(
  query: Dict(String, OneOrMany),
  key: String,
) -> Bool

Tell if the query has the given key.

insert

</>

pub fn insert(
  query: Dict(String, OneOrMany),
  key: String,
  value: OneOrMany,
) -> Dict(String, OneOrMany)

Insert value.

insert_list

</>

pub fn insert_list(
  query: Dict(String, OneOrMany),
  key: String,
  values: List(String),
) -> Dict(String, OneOrMany)

Set a list of values in the query.

insert_one

</>

pub fn insert_one(
  query: Dict(String, OneOrMany),
  key: String,
  value: String,
) -> Dict(String, OneOrMany)

Set a unique value in the query.

maybe_get_as_list

</>

pub fn maybe_get_as_list(
  query: Dict(String, OneOrMany),
  key: String,
) -> Result(List(String), String)

Get values from the query as a list of strings. If key is not present this returns an Error.

merge

</>

pub fn merge(
  a: Dict(String, OneOrMany),
  b: Dict(String, OneOrMany),
) -> Dict(String, OneOrMany)

parse

</>

pub fn parse(
  input: String,
  config: Config,
) -> Result(Dict(String, OneOrMany), String)

scheme_rails_like

</>

pub fn scheme_rails_like() -> Scheme

serialize

</>

pub fn serialize(
  input: Dict(String, OneOrMany),
  config: Config,
) -> String

with_scheme

</>

pub fn with_scheme(config: Config, scheme: Scheme) -> Config