blob: 05486853ac9490bb491ee7bb826bb7b835390be8 [file] [log] [blame]
Roman Elizarov5b5dc172017-03-13 15:02:30 +03001/*
2 * Copyright 2016-2017 JetBrains s.r.o.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package kotlinx.coroutines.experimental.selects
18
19/**
20 * Loops while [select] expression returns `true`.
21 *
22 * The statement of the form:
23 *
24 * ```
25 * whileSelect {
26 * /*body*/
27 * }
28 * ```
29 *
30 * is a shortcut for:
31 *
32 * ```
33 * while(select<Boolean> {
34 * /*body*/
35 * }) {}
36 */
37suspend fun whileSelect(builder: SelectBuilder<Boolean>.() -> Unit) {
38 while(select<Boolean>(builder)) {}
39}