aboutsummaryrefslogtreecommitdiff
path: root/docs/yaml/objects/runresult.yaml
blob: 36079a362b6af2859a7525f7d6602cc666c67011 (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
name: runresult
long_name: Run result object
description: |
  This object encapsulates the result of trying to compile and run a
  sample piece of code with [[compiler.run]] or
  [[run_command]].

methods:
- name: compiled
  returns: bool
  description: |
    If `true`, the compilation succeeded, if `false` it did not
    and the other methods return unspecified data. This is only available
    for `compiler.run()` results.

- name: returncode
  returns: int
  description: The return code of executing the compiled binary

- name: stderr
  returns: str
  description: The standard error produced when the command was run.

- name: stdout
  returns: str
  description: The standard out produced when the command was run.