1.2 KiB
Todo
Aiken's todo keyword is used to indicate that some code is not yet finished.
It can be useful when designing a module, type checking functions and types but leaving the implementation of the functions until later.
fn not_sure_yet() -> Int {
// The type annotations says this returns an Int, but we don't need
// to implement it yet.
todo
}
pub fn idk() {
favourite_number() * 2
}
When this code is built Aiken will type check and compile the code to ensure
it is valid, and the todo will be replaced with code that crashes the
program if that function is run.
A message can be given as a form of documentation. The message will be traced when
the todo code is run.
fn not_sure_yet() -> Int {
todo("Believe in the you that believes in yourself!")
}
When the compiler finds a todo it will print a warning, which can be useful
to avoid accidentally forgetting to remove a todo.
The warning also includes the expected type of the expression that needs to
replace the todo. This can be a useful way of asking the compiler what type
is needed if you are ever unsure.
fn main() {
my_complicated_function(
// What type does this function take again...?
todo
)
}