hyperlight_host/func/
ret_type.rs

/*
Copyright 2024 The Hyperlight Authors.

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.
*/

use hyperlight_common::flatbuffer_wrappers::function_types::{ReturnType, ReturnValue};
use tracing::{instrument, Span};

use crate::HyperlightError::ReturnValueConversionFailure;
use crate::{log_then_return, Result};

/// This is a marker trait that is used to indicate that a type is a valid Hyperlight return type.
pub trait SupportedReturnType<T> {
    /// Gets the return type of the supported return value
    fn get_hyperlight_type() -> ReturnType;

    /// Gets the value of the supported return value
    fn get_hyperlight_value(&self) -> ReturnValue;

    /// Gets the inner value of the supported return type
    fn get_inner(a: ReturnValue) -> Result<T>;
}

impl SupportedReturnType<()> for () {
    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_type() -> ReturnType {
        ReturnType::Void
    }

    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_value(&self) -> ReturnValue {
        ReturnValue::Void
    }

    #[instrument(err(Debug), skip_all, parent = Span::current(), level= "Trace")]
    fn get_inner(a: ReturnValue) -> Result<()> {
        match a {
            ReturnValue::Void => Ok(()),
            other => {
                log_then_return!(ReturnValueConversionFailure(other.clone(), "()"));
            }
        }
    }
}

impl SupportedReturnType<String> for String {
    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_type() -> ReturnType {
        ReturnType::String
    }

    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_value(&self) -> ReturnValue {
        ReturnValue::String(self.clone())
    }

    #[instrument(err(Debug), skip_all, parent = Span::current(), level= "Trace")]
    fn get_inner(a: ReturnValue) -> Result<String> {
        match a {
            ReturnValue::String(i) => Ok(i),
            other => {
                log_then_return!(ReturnValueConversionFailure(other.clone(), "String"));
            }
        }
    }
}

impl SupportedReturnType<i32> for i32 {
    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_type() -> ReturnType {
        ReturnType::Int
    }

    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_value(&self) -> ReturnValue {
        ReturnValue::Int(*self)
    }

    #[instrument(err(Debug), skip_all, parent = Span::current(), level= "Trace")]
    fn get_inner(a: ReturnValue) -> Result<i32> {
        match a {
            ReturnValue::Int(i) => Ok(i),
            other => {
                log_then_return!(ReturnValueConversionFailure(other.clone(), "i32"));
            }
        }
    }
}

impl SupportedReturnType<u32> for u32 {
    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_type() -> ReturnType {
        ReturnType::UInt
    }

    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_value(&self) -> ReturnValue {
        ReturnValue::UInt(*self)
    }

    #[instrument(err(Debug), skip_all, parent = Span::current(), level= "Trace")]
    fn get_inner(a: ReturnValue) -> Result<u32> {
        match a {
            ReturnValue::UInt(u) => Ok(u),
            other => {
                log_then_return!(ReturnValueConversionFailure(other.clone(), "u32"));
            }
        }
    }
}

impl SupportedReturnType<i64> for i64 {
    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_type() -> ReturnType {
        ReturnType::Long
    }

    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_value(&self) -> ReturnValue {
        ReturnValue::Long(*self)
    }

    #[instrument(err(Debug), skip_all, parent = Span::current(), level= "Trace")]
    fn get_inner(a: ReturnValue) -> Result<i64> {
        match a {
            ReturnValue::Long(l) => Ok(l),
            other => {
                log_then_return!(ReturnValueConversionFailure(other.clone(), "i64"));
            }
        }
    }
}

impl SupportedReturnType<u64> for u64 {
    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_type() -> ReturnType {
        ReturnType::ULong
    }

    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_value(&self) -> ReturnValue {
        ReturnValue::ULong(*self)
    }

    #[instrument(err(Debug), skip_all, parent = Span::current(), level= "Trace")]
    fn get_inner(a: ReturnValue) -> Result<u64> {
        match a {
            ReturnValue::ULong(ul) => Ok(ul),
            other => {
                log_then_return!(ReturnValueConversionFailure(other.clone(), "u64"));
            }
        }
    }
}

impl SupportedReturnType<bool> for bool {
    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_type() -> ReturnType {
        ReturnType::Bool
    }

    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_value(&self) -> ReturnValue {
        ReturnValue::Bool(*self)
    }

    #[instrument(err(Debug), skip_all, parent = Span::current(), level= "Trace")]
    fn get_inner(a: ReturnValue) -> Result<bool> {
        match a {
            ReturnValue::Bool(i) => Ok(i),
            other => {
                log_then_return!(ReturnValueConversionFailure(other.clone(), "bool"));
            }
        }
    }
}

impl SupportedReturnType<Vec<u8>> for Vec<u8> {
    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_type() -> ReturnType {
        ReturnType::VecBytes
    }

    #[instrument(skip_all, parent = Span::current(), level= "Trace")]
    fn get_hyperlight_value(&self) -> ReturnValue {
        ReturnValue::VecBytes(self.clone())
    }

    #[instrument(err(Debug), skip_all, parent = Span::current(), level= "Trace")]
    fn get_inner(a: ReturnValue) -> Result<Vec<u8>> {
        match a {
            ReturnValue::VecBytes(i) => Ok(i),
            other => {
                log_then_return!(ReturnValueConversionFailure(other.clone(), "Vec<u8>"));
            }
        }
    }
}
hyperlight_host/func/ret_type.rs

hyperlight_host/func/
ret_type.rs
