opencl-api 0.1.2

Actively maintained LTS support, OpenCL type associations for Rust
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

/*
 * functions.rs - opencl api helper functions.
 *
 * Copyright 2020-2021 Naman Bishnoi
 *
 * 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.
 */

#![allow(dead_code)]
use crate::errors::*;
use crate::objects::enums::Status;
use crate::objects::structs::StatusCode;
use crate::objects::types::{APIResult, HelperResult};
use opencl_heads::types::*;

pub fn status_update<T>(
    status_code: cl_int,
    function_name: &'static str,
    result: T,
) -> APIResult<T> {
    let status_details = status_reason(status_code, function_name);
    if StatusCode::SUCCESS != status_code {
        Err(OpenCLAPIError::StatusCodeError {
            code: Status::from(status_code),
            int_code: status_code,
            func: function_name,
            reason: status_details,
        })
    } else {
        Ok(result)
    }
}

fn status_reason(status_code: cl_int, function_name: &'static str) -> String {
    let base_url =
        "https://www.khronos.org/registry/OpenCL/specs/3.0-unified/html/OpenCL_API.html#";
    format!(
        "{}. please refer to api docs for more details about this error: {}{}",
        Status::from(status_code).reason(),
        base_url,
        function_name
    )
}

/// Converts a byte Vec into a string, removing the trailing null byte if it
/// exists.
pub fn bytes_into_string(mut bytes: Vec<u8>) -> HelperResult<String> {
    if bytes.last() == Some(&0u8) {
        bytes.pop();
    }
    let output = String::from_utf8(bytes).map(|str| String::from(str.trim()));
    match output {
        Ok(x) => Ok(x),
        Err(_) => Err(RuntimeError::CorruptedByteArray.to_error()),
    }
}

pub fn to_mut_ptr<T>(x: &mut T) -> *mut T {
    &mut *x
}

pub fn bool_to_clbool(val: bool) -> cl_bool {
    match val {
        true => 1,
        false => 0,
    }
}