blob: 1c503b358c626556927f196143aaf25ba06c1bee [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 `object` mod in crate `optee_utee`."><meta name="keywords" content="rust, rustlang, rust-lang, object"><title>optee_utee::object - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.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"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../optee_utee/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module object</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><div id="sidebar-vars" data-name="object" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">optee_utee</a>::<wbr><a class="mod" href="#">object</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></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/optee_utee/object.rs.html#18-1438" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="struct" href="struct.Attribute.html" title="optee_utee::object::Attribute struct">Attribute</a></div><div class="item-right docblock-short"><p>A general attribute (buffer or value) that can be used to populate an object or to specify
opeation parameters.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.AttributeMemref.html" title="optee_utee::object::AttributeMemref struct">AttributeMemref</a></div><div class="item-right docblock-short"><p>A buffer attribute.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.AttributeValue.html" title="optee_utee::object::AttributeValue struct">AttributeValue</a></div><div class="item-right docblock-short"><p>A value attribute.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.DataFlag.html" title="optee_utee::object::DataFlag struct">DataFlag</a></div><div class="item-right docblock-short"><p>A set of flags that controls the access rights and sharing permissions
with which the object handle is opened.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.HandleFlag.html" title="optee_utee::object::HandleFlag struct">HandleFlag</a></div><div class="item-right docblock-short"><p>A set of flags that defines Handle features.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.ObjectEnumHandle.html" title="optee_utee::object::ObjectEnumHandle struct">ObjectEnumHandle</a></div><div class="item-right docblock-short"><p>An enumerator for <a href="struct.PersistentObject.html">PersistentObject</a>s.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.ObjectHandle.html" title="optee_utee::object::ObjectHandle struct">ObjectHandle</a></div><div class="item-right docblock-short"><p>An opaque handle on an object.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.ObjectInfo.html" title="optee_utee::object::ObjectInfo struct">ObjectInfo</a></div><div class="item-right docblock-short"><p>Represent the characteristics of an object.
This info can be returned by <a href="struct.TransientObject.html">TransientObject</a> function
<a href="struct.TransientObject.html#method.info">info</a>
or <a href="struct.PersistentObject.html">PersistentObject</a> function
<a href="struct.PersistentObject.html#method.info">info</a>.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.PersistentObject.html" title="optee_utee::object::PersistentObject struct">PersistentObject</a></div><div class="item-right docblock-short"><p>An object identified by an Object Identifier and including a Data Stream.</p>
</div><div class="item-left module-item"><a class="struct" href="struct.TransientObject.html" title="optee_utee::object::TransientObject struct">TransientObject</a></div><div class="item-right docblock-short"><p>An object containing attributes but no data stream, which is reclaimed
when closed or when the TA instance is destroyed.
Transient objects are used to hold a cryptographic object (key or key-pair).</p>
</div><div class="item-left module-item"><a class="struct" href="struct.UsageFlag.html" title="optee_utee::object::UsageFlag struct">UsageFlag</a></div><div class="item-right docblock-short"><p>A set of flags that defines usages of data in TEE secure storage.</p>
</div></div><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="enum" href="enum.AttributeId.html" title="optee_utee::object::AttributeId enum">AttributeId</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="enum" href="enum.MiscellaneousConstants.html" title="optee_utee::object::MiscellaneousConstants enum">MiscellaneousConstants</a></div><div class="item-right docblock-short"><p>Miscellaneous constants.</p>
</div><div class="item-left module-item"><a class="enum" href="enum.ObjectStorageConstants.html" title="optee_utee::object::ObjectStorageConstants enum">ObjectStorageConstants</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="enum" href="enum.TransientObjectType.html" title="optee_utee::object::TransientObjectType enum">TransientObjectType</a></div><div class="item-right docblock-short"><p>Define types of <a href="struct.TransientObject.html">TransientObject</a> with predefined maximum sizes.</p>
</div><div class="item-left module-item"><a class="enum" href="enum.Whence.html" title="optee_utee::object::Whence enum">Whence</a></div><div class="item-right docblock-short"><p>Indicate the possible start offset when moving a data position in the data stream associated with a <a href="struct.PersistentObject.html">PersistentObject</a>.</p>
</div></div><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="trait" href="trait.ObjHandle.html" title="optee_utee::object::ObjHandle trait">ObjHandle</a></div><div class="item-right docblock-short"><p>A trait for an object (trasient or persistent) to return its handle.</p>
</div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="optee_utee" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
<script src="../../main.js"></script>
</body></html>