risingwave_common/util/
env_var.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::env;
16use std::ffi::OsStr;
17
18/// Checks whether the environment variable `key` is set to `true` or `1` or `t`.
19///
20/// Returns `false` if the environment variable is not set, or contains invalid characters.
21pub fn env_var_is_true(key: impl AsRef<OsStr>) -> bool {
22    env_var_is_true_or(key, false)
23}
24
25/// Checks whether the environment variable `key` is set to `true` or `1` or `t`.
26///
27/// Returns `default` if the environment variable is not set, or contains invalid characters.
28pub fn env_var_is_true_or(key: impl AsRef<OsStr>, default: bool) -> bool {
29    env::var(key)
30        .map(|value| {
31            ["1", "t", "true"]
32                .iter()
33                .any(|&s| value.eq_ignore_ascii_case(s))
34        })
35        .unwrap_or(default)
36}
risingwave_common/util/env_var.rs

risingwave_common/util/
env_var.rs
