hyperlight_common/flatbuffer_wrappers/
util.rs

1/*
2Copyright 2024 The Hyperlight Authors.
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8    http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15*/
16
17use alloc::vec::Vec;
18
19use flatbuffers::{FlatBufferBuilder, UnionWIPOffset, WIPOffset};
20
21use crate::flatbuffers::hyperlight::generated::{
22    hldouble as Fbhldouble, hldoubleArgs as FbhldoubleArgs, hlfloat as Fbhlfloat,
23    hlfloatArgs as FbhlfloatArgs, hlint as Fbhlint, hlintArgs as FbhlintArgs, hllong as Fbhllong,
24    hllongArgs as FbhllongArgs, hlsizeprefixedbuffer as Fbhlsizeprefixedbuffer,
25    hlsizeprefixedbufferArgs as FbhlsizeprefixedbufferArgs, hlstring as Fbhlstring,
26    hlstringArgs as FbhlstringArgs, hluint as Fbhluint, hluintArgs as FbhluintArgs,
27    hlulong as Fbhlulong, hlulongArgs as FbhlulongArgs, hlvoid as Fbhlvoid,
28    hlvoidArgs as FbhlvoidArgs, FunctionCallResult as FbFunctionCallResult,
29    FunctionCallResultArgs as FbFunctionCallResultArgs, ReturnValue as FbReturnValue,
30};
31
32pub fn get_flatbuffer_result_from_double(value: f64) -> Vec<u8> {
33    let mut builder = FlatBufferBuilder::new();
34    let hldouble = Fbhldouble::create(&mut builder, &FbhldoubleArgs { value });
35
36    let rt = FbReturnValue::hldouble;
37    let rv: Option<WIPOffset<UnionWIPOffset>> = Some(hldouble.as_union_value());
38
39    get_flatbuffer_result(&mut builder, rt, rv)
40}
41
42pub fn get_flatbuffer_result_from_float(value: f32) -> Vec<u8> {
43    let mut builder = FlatBufferBuilder::new();
44    let hlfloat = Fbhlfloat::create(&mut builder, &FbhlfloatArgs { value });
45
46    let rt = FbReturnValue::hlfloat;
47    let rv: Option<WIPOffset<UnionWIPOffset>> = Some(hlfloat.as_union_value());
48
49    get_flatbuffer_result(&mut builder, rt, rv)
50}
51
52pub fn get_flatbuffer_result_from_int(value: i32) -> Vec<u8> {
53    let mut builder = FlatBufferBuilder::new();
54    let hlint = Fbhlint::create(&mut builder, &FbhlintArgs { value });
55
56    let rt = FbReturnValue::hlint;
57    let rv: Option<WIPOffset<UnionWIPOffset>> = Some(hlint.as_union_value());
58
59    get_flatbuffer_result(&mut builder, rt, rv)
60}
61
62pub fn get_flatbuffer_result_from_uint(value: u32) -> Vec<u8> {
63    let mut builder = FlatBufferBuilder::new();
64    let hluint = Fbhluint::create(&mut builder, &FbhluintArgs { value });
65
66    let rt = FbReturnValue::hluint;
67    let rv: Option<WIPOffset<UnionWIPOffset>> = Some(hluint.as_union_value());
68
69    get_flatbuffer_result(&mut builder, rt, rv)
70}
71
72pub fn get_flatbuffer_result_from_long(value: i64) -> Vec<u8> {
73    let mut builder = FlatBufferBuilder::new();
74    let hllong = Fbhllong::create(&mut builder, &FbhllongArgs { value });
75
76    let rt = FbReturnValue::hllong;
77    let rv: Option<WIPOffset<UnionWIPOffset>> = Some(hllong.as_union_value());
78
79    get_flatbuffer_result(&mut builder, rt, rv)
80}
81
82pub fn get_flatbuffer_result_from_ulong(value: u64) -> Vec<u8> {
83    let mut builder = FlatBufferBuilder::new();
84    let hlulong = Fbhlulong::create(&mut builder, &FbhlulongArgs { value });
85
86    let rt = FbReturnValue::hlulong;
87    let rv: Option<WIPOffset<UnionWIPOffset>> = Some(hlulong.as_union_value());
88
89    get_flatbuffer_result(&mut builder, rt, rv)
90}
91
92pub fn get_flatbuffer_result_from_void() -> Vec<u8> {
93    let mut builder = FlatBufferBuilder::new();
94    let hlvoid = Fbhlvoid::create(&mut builder, &FbhlvoidArgs {});
95
96    let rt = FbReturnValue::hlvoid;
97    let rv: Option<WIPOffset<UnionWIPOffset>> = Some(hlvoid.as_union_value());
98
99    get_flatbuffer_result(&mut builder, rt, rv)
100}
101
102pub fn get_flatbuffer_result_from_string(value: &str) -> Vec<u8> {
103    let mut builder = FlatBufferBuilder::new();
104
105    let string_offset = builder.create_string(value);
106    let hlstring = Fbhlstring::create(
107        &mut builder,
108        &FbhlstringArgs {
109            value: Some(string_offset),
110        },
111    );
112
113    let rt = FbReturnValue::hlstring;
114    let rv: Option<WIPOffset<UnionWIPOffset>> = Some(hlstring.as_union_value());
115
116    get_flatbuffer_result(&mut builder, rt, rv)
117}
118
119pub fn get_flatbuffer_result_from_vec(data: &[u8]) -> Vec<u8> {
120    let mut builder = FlatBufferBuilder::new();
121
122    let vec_offset = builder.create_vector(data);
123
124    let hlsizeprefixedbuffer = Fbhlsizeprefixedbuffer::create(
125        &mut builder,
126        &FbhlsizeprefixedbufferArgs {
127            size_: data.len() as i32,
128            value: Some(vec_offset),
129        },
130    );
131
132    // Indicate that the return value is a size-prefixed buffer.
133    let rt = FbReturnValue::hlsizeprefixedbuffer;
134    let rv: Option<WIPOffset<UnionWIPOffset>> = Some(hlsizeprefixedbuffer.as_union_value());
135
136    // Get the FlatBuffer result.
137    get_flatbuffer_result(&mut builder, rt, rv)
138}
139
140fn get_flatbuffer_result(
141    builder: &mut FlatBufferBuilder,
142    return_value_type: FbReturnValue,
143    return_value: Option<WIPOffset<UnionWIPOffset>>,
144) -> Vec<u8> {
145    let result_offset = FbFunctionCallResult::create(
146        builder,
147        &FbFunctionCallResultArgs {
148            return_value,
149            return_value_type,
150        },
151    );
152
153    builder.finish_size_prefixed(result_offset, None);
154
155    builder.finished_data().to_vec()
156}