blob: bce66918ced3eb423e465f0a30910a0f06b74efa [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `teaclave_types` crate."><meta name="keywords" content="rust, rustlang, rust-lang, teaclave_types"><title>teaclave_types - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../teaclave_types/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../teaclave_types/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate teaclave_types</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.5.1</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">teaclave_types</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/teaclave_types/lib.rs.html#18-61">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.hashmap.html" title="teaclave_types::hashmap macro">hashmap</a></div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.impl_transit_and_into_task_state.html" title="teaclave_types::impl_transit_and_into_task_state macro">impl_transit_and_into_task_state</a></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Approve.html" title="teaclave_types::Approve struct">Approve</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Assign.html" title="teaclave_types::Assign struct">Assign</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Cancel.html" title="teaclave_types::Cancel struct">Cancel</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Create.html" title="teaclave_types::Create struct">Create</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Done.html" title="teaclave_types::Done struct">Done</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ECallStatus.html" title="teaclave_types::ECallStatus struct">ECallStatus</a></div><div class="item-right docblock-short">Status for Ecall</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EnclaveAttr.html" title="teaclave_types::EnclaveAttr struct">EnclaveAttr</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EnclaveInfo.html" title="teaclave_types::EnclaveInfo struct">EnclaveInfo</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EnclaveMeasurement.html" title="teaclave_types::EnclaveMeasurement struct">EnclaveMeasurement</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Entry.html" title="teaclave_types::Entry struct">Entry</a></div><div class="item-right docblock-short">The entry for one line audit log</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EntryBuilder.html" title="teaclave_types::EntryBuilder struct">EntryBuilder</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ExecutionResult.html" title="teaclave_types::ExecutionResult struct">ExecutionResult</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ExternalID.html" title="teaclave_types::ExternalID struct">ExternalID</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Fail.html" title="teaclave_types::Fail struct">Fail</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FileAgentRequest.html" title="teaclave_types::FileAgentRequest struct">FileAgentRequest</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FileAuthTag.html" title="teaclave_types::FileAuthTag struct">FileAuthTag</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Finish.html" title="teaclave_types::Finish struct">Finish</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Function.html" title="teaclave_types::Function struct">Function</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FunctionArgument.html" title="teaclave_types::FunctionArgument struct">FunctionArgument</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FunctionArguments.html" title="teaclave_types::FunctionArguments struct">FunctionArguments</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FunctionBuilder.html" title="teaclave_types::FunctionBuilder struct">FunctionBuilder</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FunctionInput.html" title="teaclave_types::FunctionInput struct">FunctionInput</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FunctionInputFile.html" title="teaclave_types::FunctionInputFile struct">FunctionInputFile</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FunctionInputFiles.html" title="teaclave_types::FunctionInputFiles struct">FunctionInputFiles</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FunctionOutput.html" title="teaclave_types::FunctionOutput struct">FunctionOutput</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FunctionOutputFile.html" title="teaclave_types::FunctionOutputFile struct">FunctionOutputFile</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FunctionOutputFiles.html" title="teaclave_types::FunctionOutputFiles struct">FunctionOutputFiles</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FunctionUsage.html" title="teaclave_types::FunctionUsage struct">FunctionUsage</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.HandleFileInfo.html" title="teaclave_types::HandleFileInfo struct">HandleFileInfo</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OutputsTags.html" title="teaclave_types::OutputsTags struct">OutputsTags</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OwnerList.html" title="teaclave_types::OwnerList struct">OwnerList</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Run.html" title="teaclave_types::Run struct">Run</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Stage.html" title="teaclave_types::Stage struct">Stage</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StagedFileInfo.html" title="teaclave_types::StagedFileInfo struct">StagedFileInfo</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StagedFiles.html" title="teaclave_types::StagedFiles struct">StagedFiles</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StagedFunction.html" title="teaclave_types::StagedFunction struct">StagedFunction</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StagedFunctionBuilder.html" title="teaclave_types::StagedFunctionBuilder struct">StagedFunctionBuilder</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StagedTask.html" title="teaclave_types::StagedTask struct">StagedTask</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StagedTaskBuilder.html" title="teaclave_types::StagedTaskBuilder struct">StagedTaskBuilder</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Task.html" title="teaclave_types::Task struct">Task</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TaskFailure.html" title="teaclave_types::TaskFailure struct">TaskFailure</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TaskFileOwners.html" title="teaclave_types::TaskFileOwners struct">TaskFileOwners</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TaskFiles.html" title="teaclave_types::TaskFiles struct">TaskFiles</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TaskOutputs.html" title="teaclave_types::TaskOutputs struct">TaskOutputs</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TaskState.html" title="teaclave_types::TaskState struct">TaskState</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TeaclaveInputFile.html" title="teaclave_types::TeaclaveInputFile struct">TeaclaveInputFile</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TeaclaveOutputFile.html" title="teaclave_types::TeaclaveOutputFile struct">TeaclaveOutputFile</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.User.html" title="teaclave_types::User struct">User</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UserAuthClaims.html" title="teaclave_types::UserAuthClaims struct">UserAuthClaims</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UserID.html" title="teaclave_types::UserID struct">UserID</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WorkerCapability.html" title="teaclave_types::WorkerCapability struct">WorkerCapability</a></div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Executor.html" title="teaclave_types::Executor enum">Executor</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ExecutorType.html" title="teaclave_types::ExecutorType enum">ExecutorType</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.FileCrypto.html" title="teaclave_types::FileCrypto enum">FileCrypto</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.HandleFileCommand.html" title="teaclave_types::HandleFileCommand enum">HandleFileCommand</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SgxStatus.html" title="teaclave_types::SgxStatus enum">SgxStatus</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TaskResult.html" title="teaclave_types::TaskResult enum">TaskResult</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TaskStatus.html" title="teaclave_types::TaskStatus enum">TaskStatus</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TeeServiceError.html" title="teaclave_types::TeeServiceError enum">TeeServiceError</a></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.UserRole.html" title="teaclave_types::UserRole enum">UserRole</a></div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CANCEL_QUEUE_KEY.html" title="teaclave_types::CANCEL_QUEUE_KEY constant">CANCEL_QUEUE_KEY</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.ES_ERR_FFI_INSUFFICIENT_OUTBUF_SIZE.html" title="teaclave_types::ES_ERR_FFI_INSUFFICIENT_OUTBUF_SIZE constant">ES_ERR_FFI_INSUFFICIENT_OUTBUF_SIZE</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.ES_ERR_GENERAL.html" title="teaclave_types::ES_ERR_GENERAL constant">ES_ERR_GENERAL</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.ES_ERR_INVALID_PARAMETER.html" title="teaclave_types::ES_ERR_INVALID_PARAMETER constant">ES_ERR_INVALID_PARAMETER</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.ES_OK.html" title="teaclave_types::ES_OK constant">ES_OK</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.FILE_AUTH_TAG_LENGTH.html" title="teaclave_types::FILE_AUTH_TAG_LENGTH constant">FILE_AUTH_TAG_LENGTH</a></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.QUEUE_KEY.html" title="teaclave_types::QUEUE_KEY constant">QUEUE_KEY</a></div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.StateTag.html" title="teaclave_types::StateTag trait">StateTag</a></div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Storable.html" title="teaclave_types::Storable trait">Storable</a></div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TeaclaveExecutor.html" title="teaclave_types::TeaclaveExecutor trait">TeaclaveExecutor</a></div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TeaclaveRuntime.html" title="teaclave_types::TeaclaveRuntime trait">TeaclaveRuntime</a></div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_hex.html" title="teaclave_types::from_hex fn">from_hex</a></div><div class="item-right docblock-short">Deserializes a hex string to a <code>SgxMeasurement</code> (i.e., [0; 32]).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.read_all_bytes.html" title="teaclave_types::read_all_bytes fn">read_all_bytes</a></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.tonic_error.html" title="teaclave_types::tonic_error fn">tonic_error</a></div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.FunctionRuntime.html" title="teaclave_types::FunctionRuntime type">FunctionRuntime</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.SgxMeasurement.html" title="teaclave_types::SgxMeasurement type">SgxMeasurement</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.TeaclaveServiceResponseResult.html" title="teaclave_types::TeaclaveServiceResponseResult type">TeaclaveServiceResponseResult</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.TeeServiceResult.html" title="teaclave_types::TeeServiceResult type">TeeServiceResult</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.UserList.html" title="teaclave_types::UserList type">UserList</a></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="teaclave_types" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>