randomx-rust-wrapper 0.4.2

RandomX Rust wrapper intended for Fluence Capacity Commitment prover and verifier
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

/*
 * Copyright 2024 Fluence Labs Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#![warn(rust_2018_idioms)]
#![warn(rust_2021_compatibility)]
#![deny(
    dead_code,
    nonstandard_style,
    unused_imports,
    unused_mut,
    unused_variables,
    unused_unsafe,
    unreachable_patterns
)]

pub mod bindings;
pub mod cache;
pub mod dataset;
pub mod errors;
pub mod flags;
pub mod result_hash;
#[cfg(test)]
mod tests;
pub mod vm;

pub type RResult<T> = Result<T, errors::RandomXError>;

pub use cache::Cache;
pub use dataset::Dataset;
pub use errors::RandomXError;
pub use errors::VmCreationError;
pub use flags::RandomXFlags;
pub use result_hash::ResultHash;
pub use vm::RandomXVM;

macro_rules! try_alloc {
    ($alloc:expr, $error:expr) => {{
        let result = unsafe { $alloc };
        if result.is_null() {
            return Err($error)?;
        }

        result
    }};
}

pub(crate) use try_alloc;