rust/src/doc/trpl/if-let.md

1.7 KiB
Raw Blame History

% if let

if let allows you to combine if and let together to reduce the overhead of certain kinds of pattern matches.

For example, lets say we have some sort of Option<T>. We want to call a function on it if its Some<T>, but do nothing if its None. That looks like this:

# let option = Some(5);
# fn foo(x: i32) { }
match option {
    Some(x) => { foo(x) },
    None => {},
}

We dont have to use match here, for example, we could use if:

# let option = Some(5);
# fn foo(x: i32) { }
if option.is_some() {
    let x = option.unwrap();
    foo(x);
}

Neither of these options is particularly appealing. We can use if let to do the same thing in a nicer way:

# let option = Some(5);
# fn foo(x: i32) { }
if let Some(x) = option {
    foo(x);
}

If a pattern matches successfully, it binds any appropriate parts of the value to the identifiers in the pattern, then evaluates the expression. If the pattern doesnt match, nothing happens.

If you want to do something else when the pattern does not match, you can use else:

# let option = Some(5);
# fn foo(x: i32) { }
# fn bar() { }
if let Some(x) = option {
    foo(x);
} else {
    bar();
}

while let

In a similar fashion, while let can be used when you want to conditionally loop as long as a value matches a certain pattern. It turns code like this:

# let option: Option<i32> = None;
loop {
    match option {
        Some(x) => println!("{}", x),
        None => break,
    }
}

Into code like this:

# let option: Option<i32> = None;
while let Some(x) = option {
    println!("{}", x);
}