| <!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="Represent the characteristics of an object. This info can be returned by TransientObject function info or PersistentObject function info."><meta name="keywords" content="rust, rustlang, rust-lang, ObjectInfo"><title>ObjectInfo in 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 struct"><!--[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">☰</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">Struct ObjectInfo</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.data_size">data_size</a><a href="#method.from_raw">from_raw</a><a href="#method.object_size">object_size</a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2 class="location">Other items in<br><a href="../index.html">optee_utee</a>::<wbr><a href="index.html">object</a></h2><div id="sidebar-vars" data-name="ObjectInfo" data-ty="struct" 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">Struct <a href="../index.html">optee_utee</a>::<wbr><a href="index.html">object</a>::<wbr><a class="struct" href="#">ObjectInfo</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">−</span>]</a></span><a class="srclink" href="../../src/optee_utee/object.rs.html#152-154" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust struct"><code>pub struct ObjectInfo { /* fields omitted */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><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></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/object.rs.html#157-191" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.ObjectInfo.html" title="struct optee_utee::object::ObjectInfo">ObjectInfo</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_raw" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/object.rs.html#178-180" title="goto source code">[src]</a></div><a href="#method.from_raw" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.from_raw" class="fnname">from_raw</a>(raw: TEE_ObjectInfo) -> Self</h4></div></summary><div class="docblock"><p>Return an <a href="struct.ObjectInfo.html">ObjectInfo</a> struct based on the raw structrure <code>TEE_ObjectInfo</code>. |
| The raw structure contains following fields:</p> |
| <ol> |
| <li><code>objectType</code>: The parameter represents one of the |
| <a href="enum.TransientObjectType.html">TransientObjectType</a>.</li> |
| <li><code>objectSize</code>: The current size in bits of the object as determined by its attributes. |
| This will always be less than or equal to maxObjectSize. Set to 0 for uninitialized and data only objects.</li> |
| <li><code>maxObjectSize</code>: The maximum objectSize which this object can represent. |
| 3.1) For a <a href="struct.PersistentObject.html">PersistentObject</a>, set to <code>objectSize</code>. |
| 3.2) For a <a href="struct.TransientObject.html">TransientObject</a>, set to the parameter <code>maxObjectSize</code> passed to |
| <a href="struct.TransientObject.html#method.allocate">allocate</a>.</li> |
| <li><code>objectUsage</code>: A bit vector of UsageFlag.</li> |
| <li><code>dataSize</code>: |
| 5.1) For a <a href="struct.PersistentObject.html">PersistentObject</a>, set to the current size of the data associated with the object. |
| 5.2) For a <a href="struct.TransientObject.html">TransientObject</a>, always set to 0.</li> |
| <li><code>dataPosition</code>: |
| 6.1) For a <a href="struct.PersistentObject.html">PersistentObject</a>, set to the current position in the data for this handle. |
| Data positions for different handles on the same object may differ. |
| 6.2) For a <a href="struct.TransientObject.html">TransientObject</a>, set to 0.</li> |
| <li><code>handleFlags</code>: A bit vector containing one or more <a href="struct.HandleFlag.html">HandleFlag</a> or <a href="struct.DataFlag.html">DataFlag</a>.</li> |
| </ol> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.data_size" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/object.rs.html#183-185" title="goto source code">[src]</a></div><a href="#method.data_size" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.data_size" class="fnname">data_size</a>(&self) -> usize</h4></div></summary><div class="docblock"><p>Return the <code>dataSize</code> field of the raw structrure <code>TEE_ObjectInfo</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.object_size" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/object.rs.html#188-190" title="goto source code">[src]</a></div><a href="#method.object_size" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.object_size" class="fnname">object_size</a>(&self) -> usize</h4></div></summary><div class="docblock"><p>Return the <code>objectSize</code> field of the raw structrure <code>TEE_ObjectInfo</code>.</p> |
| </div></details></div></details><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl RefUnwindSafe for <a class="struct" href="struct.ObjectInfo.html" title="struct optee_utee::object::ObjectInfo">ObjectInfo</a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl Send for <a class="struct" href="struct.ObjectInfo.html" title="struct optee_utee::object::ObjectInfo">ObjectInfo</a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl Sync for <a class="struct" href="struct.ObjectInfo.html" title="struct optee_utee::object::ObjectInfo">ObjectInfo</a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl Unpin for <a class="struct" href="struct.ObjectInfo.html" title="struct optee_utee::object::ObjectInfo">ObjectInfo</a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl UnwindSafe for <a class="struct" href="struct.ObjectInfo.html" title="struct optee_utee::object::ObjectInfo">ObjectInfo</a></h3></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> Any for T <span class="where fmt-newline">where<br> T: 'static + ?Sized, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="#tymethod.type_id">Read more</a></p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> Borrow<T> for T <span class="where fmt-newline">where<br> T: ?Sized, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">borrow</a>(&self) -> &T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="#tymethod.borrow">Read more</a></p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> BorrowMut<T> for T <span class="where fmt-newline">where<br> T: ?Sized, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="#tymethod.borrow_mut">Read more</a></p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> From<T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.from" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">from</a>(t: T) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> Into<U> for T <span class="where fmt-newline">where<br> U: From<T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">into</a>(self) -> U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> TryFrom<U> for T <span class="where fmt-newline">where<br> U: Into<T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Error" class="type">Error</a> = Infallible</h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></div></summary><div class='docblock'><p>Performs the conversion.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> TryInto<U> for T <span class="where fmt-newline">where<br> U: TryFrom<T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Error" class="type">Error</a> = <U as TryFrom<T>>::Error</h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></div></summary><div class='docblock'><p>Performs the conversion.</p> |
| </div></details></div></details></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> |
