Конструкція управління match

Rust має вкрай потужну конструкцію управління, що зветься match, яка дозволяє нам порівнювати значення із кількома шаблонами та потім виконати код, виходячи з того, який шаблон відповідає цьому значенню. Шаблони можуть складатися з літералів, імен змінних, символів узагальнення і багатьох інших речей; Розділ 18 розповідає про всі різні види шаблонів і що вони роблять. Потужність match походить від виразності шаблонів і того факту, що компілятор перевіряє, щоб усі можливі ситуації були оброблені.

Вираз match можна уявити собі як сортувальну машину для монет: монети ковзають жолобом з отворами різних розмірів, і кожна монета падає крізь перший отвір, в який вона проходить. Так само значення проходить крізь кожен шаблон в match, і на першому шаблоні, якому воно відповідає, значення "провалюється" в пов'язаний блок коду, де може бути використане при його виконанні.

Оскільки ми згадали монети, використаємо їх як приклад використання match! Ми можемо написати функцію, що приймає невідому монету США і, так само як і лічильна машина, визначає, яка це монета і повертає її значення в центах, як показано в Блоці коду 6-3.

enum Coin {
    Penny,
    Nickel,
    Dime,
    Quarter,
}

fn value_in_cents(coin: Coin) -> u8 {
    match coin {
        Coin::Penny => 1,
        Coin::Nickel => 5,
        Coin::Dime => 10,
        Coin::Quarter => 25,
    }
}

fn main() {}

Listing 6-3: An enum and a match expression that has the variants of the enum as its patterns

Розберімо match у функції value_in_cents. По-перше, ми пишемо ключове слово match, за яким іде вираз, у цьому випадку - значення coin. Це дуже схоже на вираз, що використовується в if, але є велика відмінність: в if вираз має повертати булеве значення, а тут значення може бути будь-якого типу. Тип coin у цьому прикладі - енум Coin, який ми визначили у першому рядку.

Далі йдуть рукави match. Рукав має дві частини: шаблон і код. Перший рукав має шаблон, що є значенням Coin::Penny, після чого оператор => відокремлює шаблон і код, що буде виконано. Код у цьому випадку - просто значення 1. Кожен рукав відокремлений від наступного комою.

Коли виконується вираз match, значення по черзі порівнюється із шаблоном кожного рукава. Якщо шаблон відповідає значенню, виконується пов'язаний із цим шаблоном код. Якщо шаблон не відповідає значенню, виконання передається наступному рукаву, як монетка в сортувальній машині. Рукавів може бути стільки, скільки нам потрібно: у Блоці коду 6-3 match має чотири рукави.

Код, пов'язаний з кожним рукавом, є виразом, і кінцеве значення виразу у відповідному рукаві є значенням, яке повертається для всього виразу match.

Фігурні дужки зазвичай не використовуються, якщо код рукава match невеликий, як у Блоці коду 6-3, де кожен рукав просто повертає значення. Якщо ви хочете виконати багато рядків коду у рукаві match, то маєте скористатися фігурними дужками, кома після яких в такому разі не обов'язкова. Наприклад, наступний код виводитиме “Lucky penny!” кожного разу, коли метод викличуть для Coin::Penny, але також поверне останнє значення блоку, тобто 1:

enum Coin {
    Penny,
    Nickel,
    Dime,
    Quarter,
}

fn value_in_cents(coin: Coin) -> u8 {
    match coin {
        Coin::Penny => {
            println!("Lucky penny!");
            1
        }
        Coin::Nickel => 5,
        Coin::Dime => 10,
        Coin::Quarter => 25,
    }
}

fn main() {}

Шаблони, які прив’язуються до значень

Інша корисна властивість рукавів match полягає в тому, що вони можуть зв'язуватися з частинами значення, що відповідає шаблону. Таким чином ми можемо дістати значення з варіантів енумів.

Наприклад, змінімо один з варіантів енума, щоб він мав дані усередині. З 1999 по 2008 роки Сполучені Штати карбували четвертаки з різними дизайнами для кожного з 50 штатів на одному боці. Інші монети не мають окремих дизайнів для штатів, тому лише четвертаки мають таке додаткове значення. Ми можемо додати цю інформацію до нашого енума, змінивши варіант Quarter, аби він містив у собі значення UsState, що й зроблено в Блоці коду 6-4.

#[derive(Debug)] // so we can inspect the state in a minute
enum UsState {
    Alabama,
    Alaska,
    // --snip--
}

enum Coin {
    Penny,
    Nickel,
    Dime,
    Quarter(UsState),
}

fn main() {}

Listing 6-4: A Coin enum in which the Quarter variant also holds a UsState value

Уявімо, що наш друг намагається зібрати всі 50 четвертаків різних штатів. Сортуючи дріб'язок по типах монет, ми також будемо називати назви штатів, пов'язаних з кожним четвертаком, щоб, якщо такого наш друг такого не має, він зміг би додати його до своєї колекції.

У виразі match у цьому коді ми додаємо змінну, що зветься state до шаблону, що відповідає значенню варіанту Coin::Quarter. Коли шаблон Coin::Quarter буде відповідним до виразу, змінна state зв'яжеться зі значенням штату цього четвертака. Тоді ми можемо використати state у коді цього рукава, ось так:

#[derive(Debug)]
enum UsState {
    Alabama,
    Alaska,
    // --snip--
}

enum Coin {
    Penny,
    Nickel,
    Dime,
    Quarter(UsState),
}

fn value_in_cents(coin: Coin) -> u8 {
    match coin {
        Coin::Penny => 1,
        Coin::Nickel => 5,
        Coin::Dime => 10,
        Coin::Quarter(state) => {
            println!("State quarter from {:?}!", state);
            25
        }
    }
}

fn main() {
    value_in_cents(Coin::Quarter(UsState::Alaska));
}

Якщо ми викличемо value_in_cents(Coin::Quarter(UsState::Alaska)), значення coin буде Coin::Quarter(UsState::Alaska). Коли ми порівняємо це значення з усіма рукавами, то не підійде жоден, поки ми не дістанемося Coin::Quarter(state). У цьому місці state буде зв'язане зі значенням UsState::Alaska. Ми зможемо тоді скористатися цим зв'язуванням у виразі println!, отримавши таким чином внутрішнє значення штату з енума Coin для варіанту Quarter.

Зіставлення з Option<T>

У попередньому підрозділі ми хотіли дістати внутрішнє значення типу T з варіанту Some, коли працювали з Option<T>; з Option<T> ми теж можемо скористатися конструкцією match, так само як робили з енумом Coin! Замість монет ми порівнюватимемо варіанти Option<T>, але вираз match при цьому працює тим самим чином.

Хай, скажімо, ми хочемо написати функцію, що приймає Option<i32>, і якщо він містить значення, додає один до цього значення. А якщо там немає значення всередині, функція має повертати значення None і не намагатися виконати жодних дій.

This function is very easy to write, thanks to match, and will look like Listing 6-5.

fn main() {
    fn plus_one(x: Option<i32>) -> Option<i32> {
        match x {
            None => None,
            Some(i) => Some(i + 1),
        }
    }

    let five = Some(5);
    let six = plus_one(five);
    let none = plus_one(None);
}

Listing 6-5: A function that uses a match expression on an Option<i32>

Розгляньмо детальніше перше виконання plus_one. Коли ми викликаємо plus_one(five), змінна x у тілі plus_one матиме значення Some(5). Далі ми порівнюємо це значення з кожним рукавом match:

fn main() {
    fn plus_one(x: Option<i32>) -> Option<i32> {
        match x {
            None => None,
            Some(i) => Some(i + 1),
        }
    }

    let five = Some(5);
    let six = plus_one(five);
    let none = plus_one(None);
}

Значення Some(5) не відповідає шаблону None, тому ми переходимо до наступного рукава:

fn main() {
    fn plus_one(x: Option<i32>) -> Option<i32> {
        match x {
            None => None,
            Some(i) => Some(i + 1),
        }
    }

    let five = Some(5);
    let six = plus_one(five);
    let none = plus_one(None);
}

Чи відповідає Some(5) шаблону Some(i)? Так! Ми маємо той самий варіант. Змінна i зв'язується зі значенням, що міститься в Some, тобто i набуває значення 5. Далі виконується код у рукаві match, тобто додається один до значення i і створюється нове значення Some із результатом 6 всередині.

Тепер розгляньмо другий виклик plus_one у Блоці коду 6-5, де x дорівнює None. Ми входимо в match і порівнюємо перший рукав:

fn main() {
    fn plus_one(x: Option<i32>) -> Option<i32> {
        match x {
            None => None,
            Some(i) => Some(i + 1),
        }
    }

    let five = Some(5);
    let six = plus_one(five);
    let none = plus_one(None);
}

Підходить! Немає значення, до якого треба додавати, і програма зупиняється і повертає значення None, що стоїть праворуч від =>. Оскільки перший рукав відповідає значенню, решта рукавів не перевіряються.

Комбінування match і енумів корисне в багатьох ситуаціях. Ви часто бачитимете цей шаблон у коді Rust: match із енумом, зв'язування змінної з даними усередині, і виконання коду відповідно до цього. Це спершу трохи мудровано, але щойно ви звикнете до цього, то бажатимете мати таку конструкцію в усіх мовах. Ця конструкція - незмінний улюбленець користувачів Rust.

Match вимагає вичерпності

Є ще один бік match, що ми маємо обговорити: шаблони рукавів мають покривати всі можливості. Розгляньте таку версію нашої функції plus_one, в якій є вада і вона не скомпілюється:

fn main() {
    fn plus_one(x: Option<i32>) -> Option<i32> {
        match x {
            Some(i) => Some(i + 1),
        }
    }

    let five = Some(5);
    let six = plus_one(five);
    let none = plus_one(None);
}

Ми не обробили варіанту None, тому цей код призводить до вади. На щастя, Rust знає, як виявляти такі вади. Якщо ми спробуємо скомпілювати цей код, то отримаємо таке повідомлення про помилку:

$ cargo run
   Compiling enums v0.1.0 (file:///projects/enums)
error[E0004]: non-exhaustive patterns: `None` not covered
   --> src/main.rs:3:15
    |
3   |         match x {
    |               ^ pattern `None` not covered
    |
note: `Option<i32>` defined here
    = note: the matched value is of type `Option<i32>`
help: ensure that all possible cases are being handled by adding a match arm with a wildcard pattern or an explicit pattern as shown
    |
4   ~             Some(i) => Some(i + 1),
5   ~             None => todo!(),
    |

For more information about this error, try `rustc --explain E0004`.
error: could not compile `enums` due to previous error

Rust знає, що ми не покрили усі можливі випадки, і навіть знає, який саме шаблон ми забули! Match в Rust вичерпні: ми маємо вичерпати всі можливі ситуації, щоб код був коректним. Особливо у випадку з Option<T>, коли Rust, запобігаючи тому, щоб ми забули явно обробити випадок None, захищає нас від припущення, що ми маємо значення, коли ми можемо мати null, таким чином припускаючись помилки на мільярд доларів, про яку ми говорили вище.

Шаблони для всіх випадків і заповнювач _

При роботі з енумами нам може знадобитися особлива дія для кількох конкретних значень, а для всіх інших значень - одна дія за замовчуванням. Уявіть, що ми розробляємо гру, де, якщо ви викинули 3 на кубику, ваш гравець не рухається, а отримує нового модного капелюха. Якщо ви викинете 7, ваш гравець втратить модного капелюха. Для всіх інших значень, ваш гравець рухається на цю кількість клітинок на ігровому полі. Ось match, що реалізовує цю логіку, де результат кидання кубика жорстко задано замість випадкового значення, і решта логіки представлена функціями без тіл, бо ми насправді реалізуємо їх поза областю видимості цього прикладу:

fn main() {
    let dice_roll = 9;
    match dice_roll {
        3 => add_fancy_hat(),
        7 => remove_fancy_hat(),
        other => move_player(other),
    }

    fn add_fancy_hat() {}
    fn remove_fancy_hat() {}
    fn move_player(num_spaces: u8) {}
}

У перших двох рукавів шаблони - літерали зі значеннями 3 і 7. У останнього рукава, що покриває всі інші можливі значення. шаблон - це змінна, яку ми вирішили назвати other. Код, що виконується в цьому рукаві, використовує змінну other, передаючи її у функцію move_player.

Цей код компілюється, хоча ми не перерахували усі можливі значення, яких може набути u8, бо останній шаблон відповідає всім значенням, які не були вказані окремо. Цей шаблон для всіх випадків задовольняє вимозі вичерпності match. Зверніть увагу, що шаблон для всіх випадків розміщується останнім, бо шаблони обчислюються послідовно. Якщо ми розмістимо рукав для всіх випадків раніше, решта рукавів ніколи не запустяться, тому Rust попередить нас, якщо ми після нього додамо ще рукави!

Rust також має шаблон, яким можна скористатися, коли нам потрібно обробити всі випадки, але ми не хочемо використовувати значення у шаблоні для всіх випадків: _ є спеціальним шаблоном, що відповідає будь-якому значенню і не зв'язується із цим значенням. Це каже Rust, що ми не збираємося використовувати це значення, і тому він не попереджатиме про невикористану змінну.

Змінімо правила гри: тепер, якщо ви викинете щось, крім 3 чи 7, то маєте кидати кубик знову. Нам більше не потрібне значення для всіх випадків, тож ми можемо змінити наш код і скористатися _ замість змінної на ім'я other:

fn main() {
    let dice_roll = 9;
    match dice_roll {
        3 => add_fancy_hat(),
        7 => remove_fancy_hat(),
        _ => reroll(),
    }

    fn add_fancy_hat() {}
    fn remove_fancy_hat() {}
    fn reroll() {}
}

This example also meets the exhaustiveness requirement because we’re explicitly ignoring all other values in the last arm; we haven’t forgotten anything.

Нарешті, змінимо правила гри ще раз, так щоб нічого не ставалося на вашому ході, якщо ви викинули щось інше, крім 3 чи 7. Це можна виразити одиничним значенням (тип порожнього кортежу, який ми згадували у підрозділі “Тип кортеж” ) у коді, що знаходиться у рукаві _:

fn main() {
    let dice_roll = 9;
    match dice_roll {
        3 => add_fancy_hat(),
        7 => remove_fancy_hat(),
        _ => (),
    }

    fn add_fancy_hat() {}
    fn remove_fancy_hat() {}
}

Here, we’re telling Rust explicitly that we aren’t going to use any other value that doesn’t match a pattern in an earlier arm, and we don’t want to run any code in this case.

Більш детально про шаблони і зіставлення з ними йдеться у Розділі 18. Ну а поки що ми перейдемо до конструкції if let, яка може бути корисною в ситуаціях, де вираз match буде надто багатослівним.