<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="The task manager, where all the tasks are managed."><metaname="keywords"content="rust, rustlang, rust-lang, TaskManager"><title>TaskManager in os::task - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../ayu.css"disabled><linkrel="stylesheet"type="text/css"href="../../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../../storage.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../main.js"></script><noscript><linkrel="stylesheet"href="../../noscript.css"></noscript><linkrel="alternate icon"type="image/png"href="../../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../../favicon.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../../os/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../../rust-logo.svg"alt="logo"></div>
</a><h2class="location"><ahref="#">TaskManager</a></h2><divclass="sidebar-elems"><section><divclass="block"><h3class="sidebar-title"><ahref="#fields">Fields</a></h3><ul><li><ahref="#structfield.inner">inner</a></li><li><ahref="#structfield.num_app">num_app</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><ul><li><ahref="#method.find_next_task">find_next_task</a></li><li><ahref="#method.get_current_token">get_current_token</a></li><li><ahref="#method.get_current_trap_cx">get_current_trap_cx</a></li><li><ahref="#method.mark_current_exited">mark_current_exited</a></li><li><ahref="#method.mark_current_suspended">mark_current_suspended</a></li><li><ahref="#method.run_first_task">run_first_task</a></li><li><ahref="#method.run_next_task">run_next_task</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><ahref="#impl-RefUnwindSafe-for-TaskManager">!RefUnwindSafe</a></li><li><ahref="#impl-Send-for-TaskManager">Send</a></li><li><ahref="#impl-Sync-for-TaskManager">Sync</a></li><li><ahref="#impl-Unpin-for-TaskManager">Unpin</a></li><li><ahref="#impl-UnwindSafe-for-TaskManager">UnwindSafe</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><ul><li><ahref="#impl-Any-for-TaskManager">Any</a></li><li><ahref="#impl-Borrow%3CT%3E-for-TaskManager">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E-for-TaskManager">BorrowMut<T></a></li><li><ahref="#impl-From%3CT%3E-for-TaskManager">From<T></a></li><li><ahref="#impl-Into%3CU%3E-for-TaskManager">Into<U></a></li><li><ahref="#impl-TryFrom%3CU%3E-for-TaskManager">TryFrom<U></a></li><li><ahref="#impl-TryInto%3CU%3E-for-TaskManager">TryInto<U></a></li></ul></div></section><h2class="location"><ahref="index.html">In os::task</a></h2></div></nav><main><divclass="width-limiter"><divclass="sub-container"><aclass="sub-logo-container"href="../../os/index.html"><imgclass="rust-logo"src="../../rust-logo.svg"alt="logo"></a><navclass="sub"><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"title="help"tabindex="-1"><buttontype="button">?</button></div><divid="settings-menu"tabindex="-1">
}</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>The task manager, where all the tasks are managed.</p>
<p>Functions implemented on <code>TaskManager</code> deals with all task state transitions
and task context switching. For convenience, you can find wrappers around it
in the module level.</p>
<p>Most of <code>TaskManager</code> are hidden behind the field <code>inner</code>, to defer
borrowing checks to runtime. You can see examples on how to use <code>inner</code> in
existing functions on <code>TaskManager</code>.</p>
</div></details><h2id="fields"class="fields small-section-header">Fields<ahref="#fields"class="anchor"></a></h2><spanid="structfield.num_app"class="structfield small-section-header"><ahref="#structfield.num_app"class="anchor field"></a><code>num_app: <aclass="primitive"href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a></code></span><divclass="docblock"><p>total number of tasks</p>
</div><spanid="structfield.inner"class="structfield small-section-header"><ahref="#structfield.inner"class="anchor field"></a><code>inner: <aclass="struct"href="../sync/up/struct.UPSafeCell.html"title="struct os::sync::up::UPSafeCell">UPSafeCell</a><<aclass="struct"href="struct.TaskManagerInner.html"title="struct os::task::TaskManagerInner">TaskManagerInner</a>></code></span><divclass="docblock"><p>use inner value to get mutable access</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.mark_current_suspended"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../../src/os/task/mod.rs.html#93-97">source</a></span><h4class="code-header">fn <ahref="#method.mark_current_suspended"class="fnname">mark_current_suspended</a>(&self)</h4></section></summary><divclass="docblock"><p>Change the status of current <code>Running</code> task into <code>Ready</code>.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.mark_current_exited"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../../src/os/task/mod.rs.html#100-104">source</a></span><h4class="code-header">fn <ahref="#method.mark_current_exited"class="fnname">mark_current_exited</a>(&self)</h4></section></summary><divclass="docblock"><p>Change the status of current <code>Running</code> task into <code>Exited</code>.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.find_next_task"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../../src/os/task/mod.rs.html#109-115">source</a></span><h4class="code-header">fn <ahref="#method.find_next_task"class="fnname">find_next_task</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>></h4></section></summary><divclass="docblock"><p>Find next task to run and return task id.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.get_current_token"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../../src/os/task/mod.rs.html#118-121">source</a></span><h4class="code-header">fn <ahref="#method.get_current_token"class="fnname">get_current_token</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a></h4></section></summary><divclass="docblock"><p>Get the current ‘Running’ task’s token.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.get_current_trap_cx"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../../src/os/task/mod.rs.html#124-127">source</a></span><h4class="code-header">fn <ahref="#method.get_current_trap_cx"class="fnname">get_current_trap_cx</a>(&self) ->&'static mut <aclass="struct"href="../trap/context/struct.TrapContext.html"title="struct os::trap::context::TrapContext">TrapContext</a></h4></section></summary><divclass="docblock"><p>Get the current ‘Running’ task’s trap contexts.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.run_next_task"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../../src/os/task/mod.rs.html#131-156">source</a></span><h4class="code-header">fn <ahref="#method.run_next_task"class="fnname">run_next_task</a>(&self)</h4></section></summary><divclass="docblock"><p>Switch current <code>Running</code> task to the task we have found,
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-TaskManager"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#598">source</a></span><ahref="#impl-TryFrom%3CU%3E-for-TaskManager"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error-1"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-TaskManager"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#583">source</a></span><ahref="#impl-TryInto%3CU%3E-for-TaskManager"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
