yash_builtin/
false.rs

1// This file is part of yash, an extended POSIX shell.
2// Copyright (C) 2024 WATANABE Yuki
3//
4// This program is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// This program is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with this program.  If not, see <https://www.gnu.org/licenses/>.
16
17//! False built-in
18//!
19//! This module implements the [`false` built-in], which does nothing, unsuccessfully.
20//!
21//! [`false` built-in]: https://magicant.github.io/yash-rs/builtins/false.html
22
23use crate::Result;
24use yash_env::Env;
25use yash_env::semantics::ExitStatus;
26use yash_env::semantics::Field;
27
28/// Executes the `false` built-in.
29///
30/// This is the main entry point for the `false` built-in.
31pub async fn main(_env: &mut Env, _args: Vec<Field>) -> Result {
32    Result::new(ExitStatus::FAILURE)
33}