kcl_lib/std/
convert.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
//! Conversions between types.

use derive_docs::stdlib;

use crate::{
    errors::KclError,
    execution::{ExecState, KclValue},
    std::Args,
};

/// Converts a number to integer.
pub async fn int(_exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
    let num = args.get_number()?;
    let converted = inner_int(num)?;

    Ok(args.make_user_val_from_f64(converted))
}

/// Convert a number to an integer.
///
/// DEPRECATED use floor(), ceil(), or round().
///
/// ```no_run
/// n = int(ceil(5/2))
/// assertEqual(n, 3, 0.0001, "5/2 = 2.5, rounded up makes 3")
/// // Draw n cylinders.
/// startSketchOn('XZ')
///   |> circle({ center = [0, 0], radius = 2 }, %)
///   |> extrude(5, %)
///   |> patternTransform(n, fn(id) {
///   return { translate = [4 * id, 0, 0] }
/// }, %)
/// ```
#[stdlib {
    name = "int",
    tags = ["convert"],
    deprecated = true,
}]
fn inner_int(num: f64) -> Result<f64, KclError> {
    Ok(num)
}