diff options
author | Giacomo Cavalieri <giacomo.cavalieri@icloud.com> | 2023-12-31 22:40:40 +0100 |
---|---|---|
committer | Louis Pilfold <louis@lpil.uk> | 2024-01-02 17:08:28 +0000 |
commit | f88b8321a1b323b03951fc1c9575d8269cd910b6 (patch) | |
tree | 002ef6ff7905cadd39fcd4f2d458354b2ab21a86 /src | |
parent | e21abef2da7a84d400ffecdc0d2da064e23c852c (diff) | |
download | gleam_stdlib-f88b8321a1b323b03951fc1c9575d8269cd910b6.tar.gz gleam_stdlib-f88b8321a1b323b03951fc1c9575d8269cd910b6.zip |
uri doc examples
Diffstat (limited to 'src')
-rw-r--r-- | src/gleam/uri.gleam | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/src/gleam/uri.gleam b/src/gleam/uri.gleam index 11f6ea6..f4727ed 100644 --- a/src/gleam/uri.gleam +++ b/src/gleam/uri.gleam @@ -42,18 +42,18 @@ pub type Uri { /// ## Examples /// /// ```gleam -/// > parse("https://example.com:1234/a/b?query=true#fragment") -/// Ok( -/// Uri( -/// scheme: Some("https"), -/// userinfo: None, -/// host: Some("example.com"), -/// port: Some(1234), -/// path: "/a/b", -/// query: Some("query=true"), -/// fragment: Some("fragment") -/// ) -/// ) +/// parse("https://example.com:1234/a/b?query=true#fragment") +/// // -> Ok( +/// // Uri( +/// // scheme: Some("https"), +/// // userinfo: None, +/// // host: Some("example.com"), +/// // port: Some(1234), +/// // path: "/a/b", +/// // query: Some("query=true"), +/// // fragment: Some("fragment") +/// // ) +/// // ) /// ``` /// pub fn parse(uri_string: String) -> Result(Uri, Nil) { @@ -204,8 +204,8 @@ fn extra_required(list: List(a), remaining: Int) -> Int { /// ## Examples /// /// ```gleam -/// > parse_query("a=1&b=2") -/// Ok([#("a", "1"), #("b", "2")]) +/// parse_query("a=1&b=2") +/// // -> Ok([#("a", "1"), #("b", "2")]) /// ``` /// pub fn parse_query(query: String) -> Result(List(#(String, String)), Nil) { @@ -223,8 +223,8 @@ fn do_parse_query(a: String) -> Result(List(#(String, String)), Nil) /// ## Examples /// /// ```gleam -/// > query_to_string([#("a", "1"), #("b", "2")]) -/// "a=1&b=2" +/// query_to_string([#("a", "1"), #("b", "2")]) +/// // -> "a=1&b=2" /// ``` /// pub fn query_to_string(query: List(#(String, String))) -> String { @@ -248,8 +248,8 @@ fn query_pair(pair: #(String, String)) -> StringBuilder { /// ## Examples /// /// ```gleam -/// > percent_encode("100% great") -/// "100%25%20great" +/// percent_encode("100% great") +/// // -> "100%25%20great" /// ``` /// pub fn percent_encode(value: String) -> String { @@ -265,8 +265,8 @@ fn do_percent_encode(a: String) -> String /// ## Examples /// /// ```gleam -/// > percent_decode("100%25+great") -/// Ok("100% great") +/// percent_decode("100%25+great") +/// // -> Ok("100% great") /// ``` /// pub fn percent_decode(value: String) -> Result(String, Nil) { @@ -308,8 +308,8 @@ fn remove_dot_segments(input: List(String)) -> List(String) { /// ## Examples /// /// ```gleam -/// > path_segments("/users/1") -/// ["users" ,"1"] +/// path_segments("/users/1") +/// // -> ["users" ,"1"] /// ``` /// pub fn path_segments(path: String) -> List(String) { @@ -323,9 +323,9 @@ pub fn path_segments(path: String) -> List(String) { /// ## Examples /// /// ```gleam -/// > let uri = Uri(Some("http"), None, Some("example.com"), ...) -/// > to_string(uri) -/// "http://example.com" +/// let uri = Uri(Some("http"), None, Some("example.com"), ...) +/// to_string(uri) +/// // -> "http://example.com" /// ``` /// pub fn to_string(uri: Uri) -> String { @@ -367,9 +367,9 @@ pub fn to_string(uri: Uri) -> String { /// ## Examples /// /// ```gleam -/// > let assert Ok(uri) = parse("http://example.com/path?foo#bar") -/// > origin(uri) -/// Ok("http://example.com") +/// let assert Ok(uri) = parse("http://example.com/path?foo#bar") +/// origin(uri) +/// // -> Ok("http://example.com") /// ``` /// pub fn origin(uri: Uri) -> Result(String, Nil) { |