rhai-fs 0.1.5

Filesystem package for Rhai
Documentation 
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use std::fs::File;
use std::io::prelude::*;
use std::io::SeekFrom;
use std::ops::DerefMut;

use rhai::{packages::Package, Engine, EvalAltResult, Locked, Scope, Shared};
use rhai_fs::FilesystemPackage;

#[inline(always)]
fn borrow_mut(file: &Shared<Locked<File>>) -> impl DerefMut<Target = File> + '_ {
    #[cfg(not(feature = "sync"))]
    return file.borrow_mut();

    #[cfg(feature = "sync")]
    return file.write().unwrap();
}

#[test]
fn test_reading_file() -> Result<(), Box<EvalAltResult>> {
    let mut engine = Engine::new();

    // Register our filesystem package.
    let package = FilesystemPackage::new();
    package.register_into_engine(&mut engine);

    // Read a known good file.
    let mut scope = Scope::new();

    let shared_file = Shared::new(Locked::new(tempfile::tempfile().unwrap()));
    let _ = borrow_mut(&shared_file).write(b"This is a test!").unwrap();
    borrow_mut(&shared_file).seek(SeekFrom::Start(0)).unwrap();
    scope.push_constant("FILE", shared_file);

    assert_eq!(
        engine.eval_with_scope::<String>(&mut scope, r#"FILE.read_string()"#)?,
        "This is a test!"
    );

    // Max string size is respected.
    assert_eq!(
        engine
            .set_max_string_size(4)
            .eval_with_scope::<String>(&mut scope, r#"FILE.seek(0); FILE.read_string()"#)?,
        "This"
    );

    // Lengths under max string size are respected.
    assert_eq!(
        engine
            .set_max_string_size(16)
            .eval_with_scope::<rhai::INT>(&mut scope, r#"FILE.seek(0); FILE.read_string().len"#)?,
        15
    );

    Ok(())
}

#[test]
fn test_writing_file() -> Result<(), Box<EvalAltResult>> {
    let mut engine = Engine::new();

    // Register our filesystem package.
    let package = FilesystemPackage::new();
    package.register_into_engine(&mut engine);

    // Write to a known good file.
    let shared_file = Shared::new(Locked::new(tempfile::tempfile().unwrap()));
    let mut scope = Scope::new();
    scope.push_constant("FILE", shared_file);

    assert_eq!(
        engine.eval_with_scope::<rhai::INT>(&mut scope, r#"FILE.write("This is a test!")"#)?,
        15
    );

    Ok(())
}

#[test]
fn test_seeking_file() -> Result<(), Box<EvalAltResult>> {
    let mut engine = Engine::new();

    // Register our filesystem package.
    let package = FilesystemPackage::new();
    package.register_into_engine(&mut engine);

    // Seek off the start of a known good file.
    let shared_file = Shared::new(Locked::new(tempfile::tempfile().unwrap()));
    let _ = borrow_mut(&shared_file).write(b"0This is a test!").unwrap();
    let mut scope = Scope::new();
    scope.push_constant("FILE", shared_file);

    assert_eq!(
        engine.eval_with_scope::<String>(&mut scope, r#"FILE.seek(1); FILE.read_string()"#)?,
        "This is a test!"
    );

    Ok(())
}

#[test]
#[cfg(not(feature = "no_index"))]
fn test_blob_file() -> Result<(), Box<EvalAltResult>> {
    let mut engine = Engine::new();

    // Register our filesystem package.
    let package = FilesystemPackage::new();
    package.register_into_engine(&mut engine);

    // Read a known good file.
    let shared_file = Shared::new(Locked::new(tempfile::tempfile().unwrap()));
    let _ = borrow_mut(&shared_file)
        .write(&[1, 2, 3, 4, 5, 6, 7, 8, 9])
        .unwrap();
    borrow_mut(&shared_file).seek(SeekFrom::Start(0)).unwrap();
    let mut scope = Scope::new();
    scope.push_constant("FILE", shared_file);

    assert_eq!(
        engine.eval_with_scope::<rhai::Blob>(&mut scope, r#"FILE.read_blob()"#)?,
        &[1, 2, 3, 4, 5, 6, 7, 8, 9]
    );

    // Max array size is respected.
    assert_eq!(
        engine
            .set_max_array_size(4)
            .eval_with_scope::<rhai::Blob>(&mut scope, r#"FILE.seek(0); FILE.read_blob()"#)?,
        &[1, 2, 3, 4]
    );

    // Lengths under max string size are not respected.
    assert_eq!(
        engine
            .set_max_array_size(16)
            .eval_with_scope::<rhai::INT>(&mut scope, r#"FILE.seek(0); FILE.read_blob().len"#)?,
        16
    );

    // Blob from rhai to rust.
    assert_eq!(
        engine.eval_with_scope::<rhai::Blob>(
            &mut scope,
            r#"FILE.seek(0); let x = blob(9); x.read_from_file(FILE); x"#
        )?,
        &[1, 2, 3, 4, 5, 6, 7, 8, 9]
    );

    // Blob write to file.
    assert_eq!(
        engine.eval_with_scope::<rhai::INT>(
            &mut scope,
            r#"FILE.seek(0); let x = blob(8); x.write_utf8(0..8, "test"); x.write_to_file(FILE)"#
        )?,
        8
    );

    Ok(())
}