aboutsummaryrefslogtreecommitdiff
path: root/src/gleam/io.gleam
blob: f6e7f405be9a20f69826a7929bac2fcae53621ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
if erlang {
  external type DoNotLeak

  external fn erl_print(String, List(a)) -> DoNotLeak =
    "io" "fwrite"

  /// Writes a string to standard output.
  ///
  /// ## Example
  ///
  ///    > io.print("Hi mum")
  ///    // -> Hi mum
  ///    Nil
  ///
  pub fn print(string: String) -> Nil {
    erl_print(string, [])
    Nil
  }

  /// Writes a string to standard output, appending a newline to the end.
  ///
  /// ## Example
  ///
  ///    > io.println("Hi mum")
  ///    // -> Hi mum
  ///    Nil
  ///
  pub fn println(string: String) -> Nil {
    erl_print("~ts\n", [string])
    Nil
  }

  /// Prints a value to standard output using Erlang syntax.
  ///
  /// The value is returned after being printed so it can be used in pipelines.
  ///
  /// ## Example
  ///
  ///    > io.debug("Hi mum")
  ///    // -> <<"Hi mum">>
  ///    "Hi mum"
  ///
  ///    > io.debug(Ok(1))
  ///    // -> {ok, 1}
  ///    Ok(1)
  ///
  ///    > import list
  ///    > [1, 2]
  ///    > |> list.map(fn(x) { x + 1 })
  ///    > |> io.debug
  ///    > |> list.map(fn(x) { x * 2 })
  ///    // -> [2, 3]
  ///    [4, 6]
  ///
  pub fn debug(term: anything) -> anything {
    erl_print("~tp\n", [term])
    term
  }

  /// Error value returned by `get_line` function
  ///
  pub type GetLineError {
    Eof
    NoData
  }

  /// Reads a line from standard input with the given prompt.
  ///
  /// # Example
  ///
  ///    > io.get_line("Language: ")
  ///    // -> Language: <- gleam
  ///    Ok("gleam\n")
  ///
  pub external fn get_line(prompt: String) -> Result(String, GetLineError) =
    "gleam_stdlib" "get_line"
}