aboutsummaryrefslogtreecommitdiff
path: root/src/gleam/io.gleam
blob: f9b093b041acb73cf5464b81e1d69cd84b04107a (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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
import gleam/string

/// Writes a string to standard output.
///
/// If you want your output to be printed on its own line see `println`.
///
/// ## Example
///
/// ```gleam
/// > io.print("Hi mum")
/// // -> Hi mum
/// Nil
/// ```
///
pub fn print(string: String) -> Nil {
  do_print(string)
}

if erlang {
  external fn do_print(string: String) -> Nil =
    "gleam_stdlib" "print"
}

if javascript {
  external fn do_print(String) -> Nil =
    "../gleam_stdlib.mjs" "print"
}

/// Writes a string to standard error.
///
/// If you want your output to be printed on its own line see `eprintln`.
///
/// ## Example
///
/// ```
/// > io.eprint("Hi pop")
/// // -> Hi pop
/// Nil
/// ```
///
pub fn eprint(string: String) -> Nil {
  do_eprint(string)
}

if erlang {
  external fn do_eprint(string: String) -> Nil =
    "gleam_stdlib" "eprint"
}

if javascript {
  external fn do_eprint(String) -> Nil =
    "../gleam_stdlib.mjs" "eprint"
}

/// Writes a string to standard output, appending a newline to the end.
///
/// ## Example
///
/// ```gleam
/// > io.println("Hi mum")
/// // -> Hi mum
/// Nil
/// ```
///
pub fn println(string: String) -> Nil {
  do_println(string)
}

if erlang {
  external fn do_println(string: String) -> Nil =
    "gleam_stdlib" "println"
}

if javascript {
  external fn do_println(String) -> Nil =
    "../gleam_stdlib.mjs" "log"
}

/// Writes a string to standard error, appending a newline to the end.
///
/// ## Example
///
/// ```gleam
/// > io.eprintln("Hi pop")
/// // -> Hi mum
/// Nil
/// ```
///
pub fn eprintln(string: String) -> Nil {
  do_eprintln(string)
}

if erlang {
  external fn do_eprintln(string: String) -> Nil =
    "gleam_stdlib" "eprintln"
}

if javascript {
  external fn do_eprintln(String) -> Nil =
    "../gleam_stdlib.mjs" "error"
}

/// Prints a value to standard output (stdout) yielding Gleam syntax.
///
/// The value is returned after being printed so it can be used in pipelines.
///
/// ## Example
///
/// ```gleam
/// > debug("Hi mum")
/// // -> <<"Hi mum">>
/// "Hi mum"
/// ```
///
/// ```gleam
/// > debug(Ok(1))
/// // -> {ok, 1}
/// Ok(1)
/// ```
///
/// ```gleam
/// > import list
/// > [1, 2]
/// > |> list.map(fn(x) { x + 1 })
/// > |> debug
/// > |> list.map(fn(x) { x * 2 })
/// // -> [2, 3]
/// [4, 6]
/// ```
///
pub fn debug(term: anything) -> anything {
  term
  |> string.inspect
  |> println

  term
}

/// Prints a value to standard error (stderr) yielding Gleam syntax.
///
/// The value is returned after being printed so it can be used in pipelines.
///
/// ## Example
///
/// ```gleam
/// > io.edebug("Hi pop")
/// // -> <<"Hi pop">>
/// "Hi pop"
///
/// > io.edebug(Ok(1))
/// // -> {ok, 1}
/// Ok(1)
///
/// > import list
/// > [1, 2]
/// > |> list.map(fn(x) { x + 1 })
/// > |> io.edebug
/// > |> list.map(fn(x) { x * 2 })
/// // -> [2, 3]
/// [4, 6]
/// ```
///
pub fn edebug(term: anything) -> anything {
  term
  |> string.inspect
  |> eprintln

  term
}