pjrt 0.2.0

A safe PJRT C API bindings 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
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

use std::borrow::Cow;
use std::fmt::{self, Debug, Display};

use pjrt_sys::{
    PJRT_DeviceDescription, PJRT_DeviceDescription_Attributes_Args,
    PJRT_DeviceDescription_DebugString_Args, PJRT_DeviceDescription_Id_Args,
    PJRT_DeviceDescription_Kind_Args, PJRT_DeviceDescription_ProcessIndex_Args,
    PJRT_DeviceDescription_ToString_Args,
};

use crate::named_value::NamedValueMap;
use crate::{utils, Api, GlobalDeviceId};

pub struct DeviceDescription {
    api: Api,
    pub(crate) ptr: *mut PJRT_DeviceDescription,
}

impl DeviceDescription {
    pub fn wrap(api: &Api, ptr: *mut PJRT_DeviceDescription) -> DeviceDescription {
        assert!(!ptr.is_null());
        Self {
            api: api.clone(),
            ptr,
        }
    }

    pub fn api(&self) -> &Api {
        &self.api
    }

    pub fn id(&self) -> GlobalDeviceId {
        let mut args = PJRT_DeviceDescription_Id_Args::new();
        args.device_description = self.ptr;
        args = self
            .api
            .PJRT_DeviceDescription_Id(args)
            .expect("PJRT_DeviceDescription_Id");
        args.id
    }

    pub fn process_index(&self) -> i32 {
        let mut args = PJRT_DeviceDescription_ProcessIndex_Args::new();
        args.device_description = self.ptr;
        args = self
            .api
            .PJRT_DeviceDescription_ProcessIndex(args)
            .expect("PJRT_DeviceDescription_ProcessIndex");
        args.process_index
    }

    pub fn attributes(&self) -> NamedValueMap {
        let mut args = PJRT_DeviceDescription_Attributes_Args::new();
        args.device_description = self.ptr;
        args = self
            .api
            .PJRT_DeviceDescription_Attributes(args)
            .expect("PJRT_DeviceDescription_Attributes");
        utils::to_named_value_map(args.attributes, args.num_attributes)
    }

    pub fn kind(&self) -> Cow<'_, str> {
        let mut args = PJRT_DeviceDescription_Kind_Args::new();
        args.device_description = self.ptr;
        args = self
            .api
            .PJRT_DeviceDescription_Kind(args)
            .expect("PJRT_DeviceDescription_Kind");
        utils::str_from_raw(args.device_kind, args.device_kind_size)
    }

    pub fn debug_string(&self) -> Cow<'_, str> {
        let mut args = PJRT_DeviceDescription_DebugString_Args::new();
        args.device_description = self.ptr;
        args = self
            .api
            .PJRT_DeviceDescription_DebugString(args)
            .expect("PJRT_DeviceDescription_DebugString");
        utils::str_from_raw(args.debug_string, args.debug_string_size)
    }

    pub fn to_string(&self) -> Cow<'_, str> {
        let mut args = PJRT_DeviceDescription_ToString_Args::new();
        args.device_description = self.ptr;
        args = self
            .api
            .PJRT_DeviceDescription_ToString(args)
            .expect("PJRT_DeviceDescription_ToString");
        utils::str_from_raw(args.to_string, args.to_string_size)
    }
}

impl Display for DeviceDescription {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "DeviceDescription({})", self.to_string())
    }
}

impl Debug for DeviceDescription {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "DeviceDescription({})", self.debug_string())
    }
}