dust/README.md
2024-08-13 22:25:33 -04:00

108 lines
2.6 KiB
Markdown

# Dust
High-level programming language with effortless concurrency, automatic memory management and type
safety.
Dust is a work in progress. Because it aims to deliver a high level of safety, extensive testing
is required. The language is still in the design phase, and the syntax is subject to change.
## Usage
The Dust command line tool can be used to run Dust programs. It is not yet available outside of
this repository.
```sh
cargo run --package dust-shell -- examples/hello_world.ds
```
```sh
cargo run --package dust-shell -- -c "'Hello my name is ' + read_line() + '!'"
```
Dust is easily embedded in another program. You can run a dust program of any size or complexity
with a single function.
```rust
use dust_lang::{run, Value};
fn main() {
let code = "
x = 'Dust'
y = ' is awesome!'
write_line(x + y)
42
";
let result = dust.run(code).unwrap();
assert_eq!(result, Ok(Some(Value::integer(42))));
}
```
## Concepts
### Effortless Concurrency
Dust takes it a step further by making concurrency as effortless as possible. Dust is organized
into **statements**, and any sequence of statements can be run concurrently by simply adding the
`async` keyword before the block of statements.
```rust
// Counts from 0 to 9, sleeping for an increasing amount of time between each.
count_slowly = fn (multiplier: int) {
i = 0
while i < 10 {
sleep(i * multiplier)
write_line(i.to_string())
i += 1
}
}
async {
count_slowly(200) // Finishes last
count_slowly(100) // Finishes second
count_slowly(50) // Finishes first
}
```
### Automatic Memory Management
Dust uses a garbage collector to automatically manage memory. During the analysiys phase, Dust
will determine when a value is no longer needed. It can then be removed from memory at runtime.
```rust
x = 0 // x is assigned but never used
// x is removed from memory
y = 41 // y is assigned
y + 1 // y is kept alive for this statement
// y is removed from memory
```
### Type Safety
Dust is statically typed and null-free, but the type of a value can usually be inferred from its
usage. Dust will refuse to run programs with type errors, but will usually not require type
annotations.
```rust
// These two statements are identical to Dust
x = 1
x: int = 1
// Numbers with decimals are floats
y = 10.0
y: float = 10.0
// Strings are enclosed in single or double quotes and are guaranteed to be valid UTF-8
z = "Hello, world!"
z: string = "Hello, world!"
```
Aside from the ubiqutous `bool`, `int`, `float`, and `string` types, Dust also has list, maps,
ranges, structures, enums and functions.