| <!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="A millisecond resolution structure for saving the time."><meta name="keywords" content="rust, rustlang, rust-lang, Time"><title>Time in optee_utee::time - 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 Time</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#fields">Fields</a></h3><div class="sidebar-links"><a href="#structfield.millis">millis</a><a href="#structfield.seconds">seconds</a></div><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.ree_time">ree_time</a><a href="#method.set_ta_time">set_ta_time</a><a href="#method.system_time">system_time</a><a href="#method.ta_time">ta_time</a><a href="#method.wait">wait</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-Display">Display</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-ToString">ToString</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">time</a></h2><div id="sidebar-vars" data-name="Time" 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">time</a>::<wbr><a class="struct" href="#">Time</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/time.rs.html#23-28" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust struct"><code>pub struct Time { |
| pub seconds: u32, |
| pub millis: u32, |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A millisecond resolution structure for saving the time.</p> |
| </div></details><h2 id="fields" class="fields small-section-header">Fields<a href="#fields" class="anchor"></a></h2><span id="structfield.seconds" class="structfield small-section-header"><a href="#structfield.seconds" class="anchor field"></a><code>seconds: u32</code></span><div class="docblock"><p>The field for the seconds.</p> |
| </div><span id="structfield.millis" class="structfield small-section-header"><a href="#structfield.millis" class="anchor field"></a><code>millis: u32</code></span><div class="docblock"><p>The field for the milliseconds within this second.</p> |
| </div><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/time.rs.html#30-148" 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.Time.html" title="struct optee_utee::time::Time">Time</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/time.rs.html#32-37" title="goto source code">[src]</a></div><a href="#method.new" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> Self</h4></div></summary><div class="docblock"><p>Create a new empty time structure.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.system_time" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/time.rs.html#55-59" title="goto source code">[src]</a></div><a href="#method.system_time" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.system_time" class="fnname">system_time</a>(&mut self)</h4></div></summary><div class="docblock"><p>Retrieve the current system time. |
| The origin of this system time is arbitrary and implementation-dependent. |
| Different TA instances may even have different system times. |
| The only guarantee is that the system time is not reset or rolled back during the life of a |
| given TA instance, so it can be used to compute time differences and operation deadlines.</p> |
| <h1 id="example" class="section-header"><a href="#example">Example</a></h1> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">time</span> <span class="op">=</span> <span class="ident">Time::new</span>(); |
| <span class="ident">time</span>.<span class="ident">system_time</span>()<span class="question-mark">?</span>;</code></pre></div> |
| <h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1> |
| <ol> |
| <li>If the Implementation detects any error.</li> |
| </ol> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.wait" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/time.rs.html#82-87" title="goto source code">[src]</a></div><a href="#method.wait" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.wait" class="fnname">wait</a>(timeout: u32) -> <a class="type" href="../type.Result.html" title="type optee_utee::Result">Result</a><()></h4></div></summary><div class="docblock"><p>Wait for the specified number of milliseconds or wait forever if timeout equals |
| <code>raw::TEE_TIMEOUT_INFINITE</code> (0xFFFFFFFF). The waiting timer is <code>System Time</code>.</p> |
| <h1 id="parameters" class="section-header"><a href="#parameters">Parameters</a></h1> |
| <ol> |
| <li><code>timeout</code>: The number of milliseconds to wait, or <code>raw::TEE_TIMEOUT_INFINITE</code>.</li> |
| </ol> |
| <h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="ident">Time::wait</span>(<span class="number">1000</span>)<span class="question-mark">?</span>;</code></pre></div> |
| <h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1> |
| <ol> |
| <li><code>Cancel</code>: If the wait has been cancelled.</li> |
| </ol> |
| <h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1> |
| <ol> |
| <li>If the Implementation detects any error.</li> |
| </ol> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ta_time" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/time.rs.html#113-118" title="goto source code">[src]</a></div><a href="#method.ta_time" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.ta_time" class="fnname">ta_time</a>(&mut self) -> <a class="type" href="../type.Result.html" title="type optee_utee::Result">Result</a><()></h4></div></summary><div class="docblock"><p>Retrieve the persisten time of the Trusted Application. Since the timer is not |
| automatically set, this function should be called after <a href="struct.Time.html#method.set_ta_time">set_ta_time</a>. |
| The time is a real-time source of time and the origin of this time is set individually by each Trusted Application. |
| Also, the time SHALL persist across reboots.</p> |
| <h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">time</span> <span class="op">=</span> <span class="ident">Time</span>()<span class="question-mark">?</span>; |
| <span class="ident">time</span>.<span class="ident">system_time</span>()<span class="question-mark">?</span>; |
| <span class="ident">time</span>.<span class="ident">set_ta_time</span>()<span class="question-mark">?</span>; |
| <span class="ident">time</span>.<span class="ident">ta_time</span>()<span class="question-mark">?</span>;</code></pre></div> |
| <h1 id="errors-1" class="section-header"><a href="#errors-1">Errors</a></h1> |
| <ol> |
| <li><code>TimeNotSet</code>: Time is not set.</li> |
| <li><code>TimeNeedsReset</code>: Time needs to be reset.</li> |
| <li><code>Overflow</code>: The number of seconds in the TA Persistent Time overflows the range of a |
| <code>u32</code>. The field <code>seconds</code> is still set to the TA Persistent Time truncated to 32 bits.</li> |
| </ol> |
| <h1 id="panics-2" class="section-header"><a href="#panics-2">Panics</a></h1> |
| <ol> |
| <li>If the Implementation detects any error.</li> |
| </ol> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.set_ta_time" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/time.rs.html#130-135" title="goto source code">[src]</a></div><a href="#method.set_ta_time" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.set_ta_time" class="fnname">set_ta_time</a>(&self) -> <a class="type" href="../type.Result.html" title="type optee_utee::Result">Result</a><()></h4></div></summary><div class="docblock"><p>Set the persistent time of the current Trusted Application.</p> |
| <h1 id="errors-2" class="section-header"><a href="#errors-2">Errors</a></h1> |
| <ol> |
| <li><code>OutOfMemory</code>: If not enough memory is available to complete the operation.</li> |
| <li><code>SotrageNoSpace</code>: If insufficient storage space is available to complete the operation.</li> |
| </ol> |
| <h1 id="panics-3" class="section-header"><a href="#panics-3">Panics</a></h1> |
| <ol> |
| <li>If the Implementation detects any error.</li> |
| </ol> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.ree_time" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/time.rs.html#143-147" title="goto source code">[src]</a></div><a href="#method.ree_time" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.ree_time" class="fnname">ree_time</a>(&mut self)</h4></div></summary><div class="docblock"><p>Retrieve the current REE system time. |
| The time is as trusted as the REE itself and may also be tampered by the user.</p> |
| <p>Panics</p> |
| <ol> |
| <li>If the Implementation detects any error.</li> |
| </ol> |
| </div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Display" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/time.rs.html#150-158" title="goto source code">[src]</a></div><a href="#impl-Display" class="anchor"></a><h3 class="code-header in-band">impl Display for <a class="struct" href="struct.Time.html" title="struct optee_utee::time::Time">Time</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../src/optee_utee/time.rs.html#151-157" title="goto source code">[src]</a></div><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="#tymethod.fmt">Read more</a></p> |
| </div></details></div></details></div><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.Time.html" title="struct optee_utee::time::Time">Time</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.Time.html" title="struct optee_utee::time::Time">Time</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.Time.html" title="struct optee_utee::time::Time">Time</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.Time.html" title="struct optee_utee::time::Time">Time</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.Time.html" title="struct optee_utee::time::Time">Time</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-ToString" class="impl has-srclink"><div class="rightside"></div><a href="#impl-ToString" class="anchor"></a><h3 class="code-header in-band">impl<T> ToString for T <span class="where fmt-newline">where<br> T: Display + ?Sized, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.to_string" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.to_string" class="anchor"></a><h4 class="code-header">pub default fn <a class="fnname">to_string</a>(&self) -> String</h4></div></summary><div class='docblock'><p>Converts the given value to a <code>String</code>. <a href="#tymethod.to_string">Read more</a></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> |
