nushell/crates/nu-command/src/random/bool.rs

97 lines
2.3 KiB
Rust
Raw Normal View History

use nu_engine::command_prelude::*;
use rand::prelude::{thread_rng, Rng};
#[derive(Clone)]
pub struct SubCommand;
impl Command for SubCommand {
fn name(&self) -> &str {
"random bool"
}
fn signature(&self) -> Signature {
Signature::build("random bool")
.input_output_types(vec![(Type::Nothing, Type::Bool)])
.allow_variants_without_examples(true)
.named(
"bias",
SyntaxShape::Number,
"Adjusts the probability of a \"true\" outcome",
Some('b'),
)
.category(Category::Random)
}
fn usage(&self) -> &str {
"Generate a random boolean value."
}
fn search_terms(&self) -> Vec<&str> {
vec!["generate", "boolean", "true", "false", "1", "0"]
}
fn run(
&self,
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
_input: PipelineData,
) -> Result<PipelineData, ShellError> {
bool(engine_state, stack, call)
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Generate a random boolean value",
example: "random bool",
result: None,
},
Example {
description: "Generate a random boolean value with a 75% chance of \"true\"",
example: "random bool --bias 0.75",
result: None,
},
]
}
}
fn bool(
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
) -> Result<PipelineData, ShellError> {
let span = call.head;
let bias: Option<Spanned<f64>> = call.get_flag(engine_state, stack, "bias")?;
let mut probability = 0.5;
if let Some(prob) = bias {
probability = prob.item;
let probability_is_valid = (0.0..=1.0).contains(&probability);
if !probability_is_valid {
2023-03-06 17:33:09 +00:00
return Err(ShellError::InvalidProbability { span: prob.span });
}
}
let mut rng = thread_rng();
let bool_result: bool = rng.gen_bool(probability);
Move Value to helpers, separate span call (#10121) # Description As part of the refactor to split spans off of Value, this moves to using helper functions to create values, and using `.span()` instead of matching span out of Value directly. Hoping to get a few more helping hands to finish this, as there are a lot of commands to update :) # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. --> --------- Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com> Co-authored-by: WindSoilder <windsoilder@outlook.com>
2023-09-03 14:27:29 +00:00
Ok(PipelineData::Value(Value::bool(bool_result, span), None))
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_examples() {
use crate::test_examples;
test_examples(SubCommand {})
}
}