mango-v4/rs/doc/mango_v4/state/struct.PerpPosition.html

120 lines
114 KiB
HTML
Raw Normal View History

<!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 `PerpPosition` struct in crate `mango_v4`."><meta name="keywords" content="rust, rustlang, rust-lang, PerpPosition"><title>PerpPosition in mango_v4::state - 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="sidebar-items.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 struct"><!--[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="../../mango_v4/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../mango_v4/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">PerpPosition</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#fields">Fields</a></h3><ul><li><a href="#structfield.asks_base_lots">asks_base_lots</a></li><li><a href="#structfield.avg_entry_price_per_base_lot">avg_entry_price_per_base_lot</a></li><li><a href="#structfield.base_position_lots">base_position_lots</a></li><li><a href="#structfield.bids_base_lots">bids_base_lots</a></li><li><a href="#structfield.cumulative_long_funding">cumulative_long_funding</a></li><li><a href="#structfield.cumulative_short_funding">cumulative_short_funding</a></li><li><a href="#structfield.long_settled_funding">long_settled_funding</a></li><li><a href="#structfield.maker_volume">maker_volume</a></li><li><a href="#structfield.market_index">market_index</a></li><li><a href="#structfield.padding">padding</a></li><li><a href="#structfield.perp_spot_transfers">perp_spot_transfers</a></li><li><a href="#structfield.quote_position_native">quote_position_native</a></li><li><a href="#structfield.quote_running_native">quote_running_native</a></li><li><a href="#structfield.realized_other_pnl_native">realized_other_pnl_native</a></li><li><a href="#structfield.realized_pnl_for_position_native">realized_pnl_for_position_native</a></li><li><a href="#structfield.realized_trade_pnl_native">realized_trade_pnl_native</a></li><li><a href="#structfield.reserved">reserved</a></li><li><a href="#structfield.settle_pnl_limit_realized_trade">settle_pnl_limit_realized_trade</a></li><li><a href="#structfield.settle_pnl_limit_settled_in_current_window_native">settle_pnl_limit_settled_in_current_window_native</a></li><li><a href="#structfield.settle_pnl_limit_window">settl
2023-02-11 06:48:57 -08:00
pub market_index: <a class="type" href="type.PerpMarketIndex.html" title="type mango_v4::state::PerpMarketIndex">PerpMarketIndex</a>,
pub padding: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">; 2]</a>,
pub settle_pnl_limit_window: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u32.html">u32</a>,
pub settle_pnl_limit_settled_in_current_window_native: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>,
pub base_position_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>,
pub quote_position_native: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>,
pub quote_running_native: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>,
2023-02-11 06:48:57 -08:00
pub long_settled_funding: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>,
pub short_settled_funding: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>,
pub bids_base_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>,
pub asks_base_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>,
pub taker_base_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>,
pub taker_quote_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>,
pub cumulative_long_funding: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a>,
pub cumulative_short_funding: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a>,
pub maker_volume: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u64.html">u64</a>,
pub taker_volume: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u64.html">u64</a>,
pub perp_spot_transfers: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>,
pub avg_entry_price_per_base_lot: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a>,
2023-02-11 06:48:57 -08:00
pub realized_trade_pnl_native: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>,
pub realized_other_pnl_native: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>,
pub settle_pnl_limit_realized_trade: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>,
2023-02-11 06:48:57 -08:00
pub realized_pnl_for_position_native: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>,
pub reserved: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">; 88]</a>,
</details>}</code></pre></div><h2 id="fields" class="fields small-section-header">Fields<a href="#fields" class="anchor"></a></h2><span id="structfield.market_index" class="structfield small-section-header"><a href="#structfield.market_index" class="anchor field"></a><code>market_index: <a class="type" href="type.PerpMarketIndex.html" title="type mango_v4::state::PerpMarketIndex">PerpMarketIndex</a></code></span><span id="structfield.padding" class="structfield small-section-header"><a href="#structfield.padding" class="anchor field"></a><code>padding: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">; 2]</a></code></span><span id="structfield.settle_pnl_limit_window" class="structfield small-section-header"><a href="#structfield.settle_pnl_limit_window" class="anchor field"></a><code>settle_pnl_limit_window: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u32.html">u32</a></code></span><div class="docblock"><p>Index of the current settle pnl limit window</p>
</div><span id="structfield.settle_pnl_limit_settled_in_current_window_native" class="structfield small-section-header"><a href="#structfield.settle_pnl_limit_settled_in_current_window_native" class="anchor field"></a><code>settle_pnl_limit_settled_in_current_window_native: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></code></span><div class="docblock"><p>Amount of realized trade pnl and unrealized pnl that was already settled this window.</p>
2023-02-11 06:48:57 -08:00
<p>Will be negative when negative pnl was settled.</p>
<p>Note that this will be adjusted for bookkeeping reasons when the realized_trade settle
limitchanges and is not useable for actually tracking how much pnl was settled
on balance.</p>
</div><span id="structfield.base_position_lots" class="structfield small-section-header"><a href="#structfield.base_position_lots" class="anchor field"></a><code>base_position_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></code></span><div class="docblock"><p>Active position size, measured in base lots</p>
</div><span id="structfield.quote_position_native" class="structfield small-section-header"><a href="#structfield.quote_position_native" class="anchor field"></a><code>quote_position_native: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a></code></span><div class="docblock"><p>Active position in quote (conversation rate is that of the time the order was settled)
measured in native quote</p>
</div><span id="structfield.quote_running_native" class="structfield small-section-header"><a href="#structfield.quote_running_native" class="anchor field"></a><code>quote_running_native: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></code></span><div class="docblock"><p>Tracks what the position is to calculate average entry &amp; break even price</p>
</div><span id="structfield.long_settled_funding" class="structfield small-section-header"><a href="#structfield.long_settled_funding" class="anchor field"></a><code>long_settled_funding: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a></code></span><div class="docblock"><p>Already settled long funding</p>
</div><span id="structfield.short_settled_funding" class="structfield small-section-header"><a href="#structfield.short_settled_funding" class="anchor field"></a><code>short_settled_funding: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a></code></span><div class="docblock"><p>Already settled short funding</p>
</div><span id="structfield.bids_base_lots" class="structfield small-section-header"><a href="#structfield.bids_base_lots" class="anchor field"></a><code>bids_base_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></code></span><div class="docblock"><p>Base lots in open bids</p>
</div><span id="structfield.asks_base_lots" class="structfield small-section-header"><a href="#structfield.asks_base_lots" class="anchor field"></a><code>asks_base_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></code></span><div class="docblock"><p>Base lots in open asks</p>
</div><span id="structfield.taker_base_lots" class="structfield small-section-header"><a href="#structfield.taker_base_lots" class="anchor field"></a><code>taker_base_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></code></span><div class="docblock"><p>Amount of base lots on the EventQueue waiting to be processed</p>
</div><span id="structfield.taker_quote_lots" class="structfield small-section-header"><a href="#structfield.taker_quote_lots" class="anchor field"></a><code>taker_quote_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></code></span><div class="docblock"><p>Amount of quote lots on the EventQueue waiting to be processed</p>
</div><span id="structfield.cumulative_long_funding" class="structfield small-section-header"><a href="#structfield.cumulative_long_funding" class="anchor field"></a><code>cumulative_long_funding: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a></code></span><div class="docblock"><p>Cumulative long funding in quote native units.
If the user paid $1 in funding for a long position, this would be 1e6.
Beware of the sign!</p>
<p>(Display only)</p>
</div><span id="structfield.cumulative_short_funding" class="structfield small-section-header"><a href="#structfield.cumulative_short_funding" class="anchor field"></a><code>cumulative_short_funding: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a></code></span><div class="docblock"><p>Cumulative short funding in quote native units
If the user paid $1 in funding for a short position, this would be -1e6.</p>
<p>(Display only)</p>
</div><span id="structfield.maker_volume" class="structfield small-section-header"><a href="#structfield.maker_volume" class="anchor field"></a><code>maker_volume: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u64.html">u64</a></code></span><div class="docblock"><p>Cumulative maker volume in quote native units</p>
<p>(Display only)</p>
</div><span id="structfield.taker_volume" class="structfield small-section-header"><a href="#structfield.taker_volume" class="anchor field"></a><code>taker_volume: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u64.html">u64</a></code></span><div class="docblock"><p>Cumulative taker volume in quote native units</p>
<p>(Display only)</p>
</div><span id="structfield.perp_spot_transfers" class="structfield small-section-header"><a href="#structfield.perp_spot_transfers" class="anchor field"></a><code>perp_spot_transfers: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></code></span><div class="docblock"><p>Cumulative number of quote native units transfered from the perp position
to the settle token spot position.</p>
<p>For example, if the user settled $1 of positive pnl into their USDC spot
position, this would be 1e6.</p>
<p>(Display only)</p>
</div><span id="structfield.avg_entry_price_per_base_lot" class="structfield small-section-header"><a href="#structfield.avg_entry_price_per_base_lot" class="anchor field"></a><code>avg_entry_price_per_base_lot: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a></code></span><div class="docblock"><p>The native average entry price for the base lots of the current position.
2023-02-11 06:48:57 -08:00
Reset to 0 when the base position reaches or crosses 0.</p>
</div><span id="structfield.realized_trade_pnl_native" class="structfield small-section-header"><a href="#structfield.realized_trade_pnl_native" class="anchor field"></a><code>realized_trade_pnl_native: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a></code></span><div class="docblock"><p>Amount of pnl that was realized by bringing the base position closer to 0.</p>
2023-02-11 06:48:57 -08:00
<p>The settlement of this type of pnl is limited by settle_pnl_limit_realized_trade.
Settling pnl reduces this value once other_pnl below is exhausted.</p>
</div><span id="structfield.realized_other_pnl_native" class="structfield small-section-header"><a href="#structfield.realized_other_pnl_native" class="anchor field"></a><code>realized_other_pnl_native: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a></code></span><div class="docblock"><p>Amount of pnl realized from fees, funding and liquidation.</p>
2023-02-11 06:48:57 -08:00
<p>This type of realized pnl is always settleable.
Settling pnl reduces this value first.</p>
</div><span id="structfield.settle_pnl_limit_realized_trade" class="structfield small-section-header"><a href="#structfield.settle_pnl_limit_realized_trade" class="anchor field"></a><code>settle_pnl_limit_realized_trade: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></code></span><div class="docblock"><p>Settle limit contribution from realized pnl.</p>
2023-02-11 06:48:57 -08:00
<p>Every time pnl is realized, this is increased by a fraction of the stable
value of the realization. It magnitude decreases when realized pnl drops below its value.</p>
</div><span id="structfield.realized_pnl_for_position_native" class="structfield small-section-header"><a href="#structfield.realized_pnl_for_position_native" class="anchor field"></a><code>realized_pnl_for_position_native: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a></code></span><div class="docblock"><p>Trade pnl, fees, funding that were added over the current positions lifetime.</p>
2023-02-11 06:48:57 -08:00
<p>Reset when the position changes sign or goes to zero.
Not decreased by settling.</p>
<p>This is tracked for display purposes: this value plus the difference between entry
price and current price of the base position is the overall pnl.</p>
</div><span id="structfield.reserved" class="structfield small-section-header"><a href="#structfield.reserved" class="anchor field"></a><code>reserved: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">; 88]</a></code></span><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#307-782">source</a><a href="#impl-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.PerpPosition.html" title="struct mango_v4::state::PerpPosition">PerpPosition</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.add_taker_trade" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#309-320">source</a><h4 class="code-header">pub fn <a href="#method.add_taker_trade" class="fnname">add_taker_trade</a>(&amp;mut self, side: <a class="enum" href="enum.Side.html" title="enum mango_v4::state::Side">Side</a>, base_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>, quote_lots: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>)</h4></section></summary><div class="docblock"><p>Add taker trade after it has been matched but before it has been process on EventQueue</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.remove_taker_trade" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#322-325">source</a><h4 class="code-header">pub fn <a href="#method.remove_taker_trade" class="fnname">remove_taker_trade</a>(&amp;mut self, base_change: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>, quote_change: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>)</h4></section></summary><div class="docblock"><p>Remove taker trade after it has been processed on EventQueue</p>
</div></details><section id="method.is_active" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#327-329">source</a><h4 class="code-header">pub fn <a href="#method.is_active" class="fnname">is_active</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.bool.html">bool</a></h4></section><section id="method.is_active_for_market" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#331-333">source</a><h4 class="code-header">pub fn <a href="#method.is_active_for_market" class="fnname">is_active_for_market</a>(&amp;self, market_index: <a class="type" href="type.PerpMarketIndex.html" title="type mango_v4::state::PerpMarketIndex">PerpMarketIndex</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.bool.html">bool</a></h4></section><section id="method.base_position_native" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#336-338">source</a><h4 class="code-header">pub fn <a href="#method.base_position_native" class="fnname">base_position_native</a>(&amp;self, market: &amp;<a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>) -&gt; <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a></h4></section><section id="method.base_position_lots" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#340-342">source</a><h4 class="code-header">pub fn <a href="#method.base_position_lots" class="fnname">base_position_lots</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></h4></section><section id="method.effective_base_position_lots" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#345-347">source</a><h4 class="code-header">pub fn <a href="#method.effective_base_position_lots" class="fnname">effective_base_position_lots</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a></h4></section><section id="method.quote_position_native" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#349-351">source</a><h4 class="code-header">pub fn <a href="#method.quote_position_native" class="fnname">quote_position_native</a>(&amp;self) -&gt; <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a></h4></section><details class="rustdoc-toggle method-toggle" open><summary><section id="method.unsettled_funding" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#361-373">source</a><h4 class="code-header">pub fn <a href="#method.unsettled_funding" class="fnname">unsettled_funding</a>(&amp;self, perp_market: &amp;<a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>) -&gt; <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a></h4></section></summary><div class="docblock"><p>The amount of funding this account still needs to pay, in native quote</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.settle_funding" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#376-390">source</a><h4 class="code-header">pub fn <a href="#method.settle_funding" class="fnname">settle_funding</a>(&amp;mut self, perp_market: &amp;<a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>)</h4></section></summary><div class="docblock"><p>Move unrealized funding payments into the quote_position</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.record_trade" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#574-584">source</a><h4 class="code-header">pub fn <a href="#method.record_trade" class="fnname">record_trade</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;perp_market: &amp;mut <a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;base_change: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;quote_change_native: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a><br>)</h4></section></summary><div class="docblock"><p>Change the base and quote positions as the result of a trade</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.has_open_orders" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#594-596">source</a><h4 class="code-header">pub fn <a href="#method.has_open_orders" class="fnname">has_open_orders</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Does the user have any orders on the book?</p>
2023-02-11 06:48:57 -08:00
<p>Note that its possible they were matched already: This only becomes
false when the fill event is processed or the orders are cancelled.</p>
</div></details><section id="method.has_open_taker_fills" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#599-601">source</a><h4 class="code-header">pub fn <a href="#method.has_open_taker_fills" class="fnname">has_open_taker_fills</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.bool.html">bool</a></h4></section><details class="rustdoc-toggle method-toggle" open><summary><section id="method.has_open_orders_or_fills" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#604-606">source</a><h4 class="code-header">pub fn <a href="#method.has_open_orders_or_fills" class="fnname">has_open_orders_or_fills</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Are there any open orders or fills that havent been processed yet?</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.avg_entry_price" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#609-612">source</a><h4 class="code-header">pub fn <a href="#method.avg_entry_price" class="fnname">avg_entry_price</a>(&amp;self, market: &amp;<a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a></h4></section></summary><div class="docblock"><p>Calculate the average entry price of the position, in native/native units</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.break_even_price" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#615-622">source</a><h4 class="code-header">pub fn <a href="#method.break_even_price" class="fnname">break_even_price</a>(&amp;self, market: &amp;<a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a></h4></section></summary><div class="docblock"><p>Calculate the break even price of the position, in native/native units</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.unsettled_pnl" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#625-630">source</a><h4 class="code-header">pub fn <a href="#method.unsettled_pnl" class="fnname">unsettled_pnl</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;perp_market: &amp;<a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;price: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a><br>) -&gt; Result&lt;<a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>&gt;</h4></section></summary><div class="docblock"><p>Calculate the PnL of the position for a given price</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.update_settle_limit" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#634-645">source</a><h4 class="code-header">pub fn <a href="#method.update_settle_limit" class="fnname">update_settle_limit</a>(&amp;mut self, market: &amp;<a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>, now_ts: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u64.html">u64</a>)</h4></section></summary><div class="docblock"><p>Updates the perp pnl limit time windowing, resetting the amount
2023-02-11 06:48:57 -08:00
of used settle-pnl budget if necessary</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.settle_limit" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#656-685">source</a><h4 class="code-header">pub fn <a href="#method.settle_limit" class="fnname">settle_limit</a>(&amp;self, market: &amp;<a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>) -&gt; (<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>, <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>)</h4></section></summary><div class="docblock"><p>Returns the (min_pnl, max_pnl) range of quote-native pnl that can be settled this window.</p>
2023-02-11 06:48:57 -08:00
<p>It contains contributions from three factors:</p>
<ul>
<li>a fraction of the base position stable value, which gives settlement limit
equally in both directions</li>
<li>the stored realized trade settle limit, which adds an extra settlement allowance
in a single direction</li>
<li>the stored realized other settle limit, which adds an extra settlement allowance
in a single direction</li>
</ul>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.available_settle_limit" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#692-705">source</a><h4 class="code-header">pub fn <a href="#method.available_settle_limit" class="fnname">available_settle_limit</a>(&amp;self, market: &amp;<a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>) -&gt; (<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>, <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>)</h4></section></summary><div class="docblock"><p>Returns the (min_pnl, max_pnl) range of quote-native pnl that may still be settled
2023-02-11 06:48:57 -08:00
this settle window.</p>
<p>The available settle limit is the settle_limit() adjusted for the amount of limit
that was already used up this window.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.apply_pnl_settle_limit" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#708-719">source</a><h4 class="code-header">pub fn <a href="#method.apply_pnl_settle_limit" class="fnname">apply_pnl_settle_limit</a>(&amp;self, market: &amp;<a class="struct" href="struct.PerpMarket.html" title="struct mango_v4::state::PerpMarket">PerpMarket</a>, pnl: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>) -&gt; <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a></h4></section></summary><div class="docblock"><p>Given some pnl, applies the pnl settle limit and returns the reduced pnl.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.record_settle" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#724-761">source</a><h4 class="code-header">pub fn <a href="#method.record_settle" class="fnname">record_settle</a>(&amp;mut self, settled_pnl: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>)</h4></section></summary><div class="docblock"><p>Update the perp position for pnl settlement</p>
2023-02-11 06:48:57 -08:00
<p>If <code>pnl</code> is positive, then that is settled away, deducting from the quote position.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.record_trading_fee" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#764-768">source</a><h4 class="code-header">pub fn <a href="#method.record_trading_fee" class="fnname">record_trading_fee</a>(&amp;mut self, fee: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>)</h4></section></summary><div class="docblock"><p>Update perp position for a maker/taker fee payment</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.record_liquidation_quote_change" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#771-774">source</a><h4 class="code-header">pub fn <a href="#method.record_liquidation_quote_change" class="fnname">record_liquidation_quote_change</a>(&amp;mut self, change: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>)</h4></section></summary><div class="docblock"><p>Adds immediately-settleable realized pnl when a liqor takes over pnl during liquidation</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.record_liquidation_pnl_takeover" class="method has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#777-781">source</a><h4 class="code-header">pub fn <a href="#method.record_liquidation_pnl_takeover" class="fnname">record_liquidation_pnl_takeover</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;change: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;recurring_limit: <a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a><br>)</h4></section></summary><div class="docblock"><p>Adds to the quote position and adds a recurring (“realized trade”) settle limit</p>
</div></details></div></details></div><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><section id="impl-BorshDeserialize-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#161">source</a><a href="#impl-BorshDeserialize-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl BorshDeserialize for <a class="struct" href="struct.PerpPosition.html" title="struct mango_v4::state::PerpPosition">PerpPosition</a><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="type.PerpMarketIndex.html" title="type mango_v4::state::PerpMarketIndex">PerpMarketIndex</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">; 2]</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u32.html">u32</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u64.html">u64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u64.html">u64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>: BorshDeserialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.
Updates the buffer to point at the remaining bytes. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from_slice" class="method trait-impl has-srclink"><a href="#method.try_from_slice" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from_slice</a>(v: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u8.html">u8</a>]) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.65.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="struct" href="https://doc.rust-lang.org/1.65.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Deserialize this instance from a slice of bytes.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-BorshSerialize-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="../../src/mango_v4/state/mango_account_components.rs.html#161">source</a><a href="#impl-BorshSerialize-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl BorshSerialize for <a class="struct" href="struct.PerpPosition.html" title="struct mango_v4::state::PerpPosition">PerpPosition</a><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="type.PerpMarketIndex.html" title="type mango_v4::state::PerpMarketIndex">PerpMarketIndex</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.array.html">; 2]</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u32.html">u32</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="https://docs.rs/fixed/~1.11/fixed/types/type.I80F48.html" title="type fixed::types::I80F48">I80F48</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html">i64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.f64.html">f64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u64.html">u64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.u64.html">u64</a>: BorshSerialize,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.i64.html"
2023-02-11 06:48:57 -08:00
the possible invalid bit patterns being checked during
<a href="CheckedBitPattern::is_valid_bit_pattern"><code>is_valid_bit_pattern</code></a>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_valid_bit_pattern" class="method trait-impl has-srclink"><a href="#method.is_valid_bit_pattern" class="anchor"></a><h4 class="code-header">fn <a class="fnname">is_valid_bit_pattern</a>(_bits: <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.reference.html">&amp;</a>T) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>If this function returns true, then it must be valid to reinterpret <code>bits</code>
as <code>&amp;Self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-CheckedCastFrom%3CSrc%3E-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/az/~1.2/src/az/lib.rs.html#366">source</a><a href="#impl-CheckedCastFrom%3CSrc%3E-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;Src, Dst&gt; <a class="trait" href="https://docs.rs/az/~1.2/az/trait.CheckedCastFrom.html" title="trait az::CheckedCastFrom">CheckedCastFrom</a>&lt;Src&gt; for Dst<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Src: <a class="trait" href="https://docs.rs/az/~1.2/az/trait.CheckedCast.html" title="trait az::CheckedCast">CheckedCast</a>&lt;Dst&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.checked_cast_from" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/az/~1.2/src/az/lib.rs.html#369">source</a><a href="#method.checked_cast_from" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/az/~1.2/az/trait.CheckedCastFrom.html#tymethod.checked_cast_from" class="fnname">checked_cast_from</a>(src: Src) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.65.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Dst&gt;</h4></section></summary><div class='docblock'>Casts the value.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-DynClone-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/dyn_clone/1.0.9/src/dyn_clone/lib.rs.html#188">source</a><a href="#impl-DynClone-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://docs.rs/dyn_clone/1.0.9/dyn_clone/trait.DynClone.html" title="trait dyn_clone::DynClone">DynClone</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/1.65.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</span></h3></section></summary><div class="impl-items"><section id="method.__clone_box" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/dyn_clone/1.0.9/src/dyn_clone/lib.rs.html#192">source</a><a href="#method.__clone_box" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/dyn_clone/1.0.9/dyn_clone/trait.DynClone.html#tymethod.__clone_box" class="fnname">__clone_box</a>(&amp;self, Private) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.unit.html">()</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/1.65.0/src/core/convert/mod.rs.html#559">source</a><a href="#impl-From%3CT%3E-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.65.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.65.0/src/core/convert/mod.rs.html#562">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.65.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -&gt; T</h4></section></summary
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Instrument-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#276">source</a><a href="#impl-Instrument-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#82">source</a><a href="#method.instrument" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the provided <a href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html" title="Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#121">source</a><a href="#method.in_current_span" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the <a href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html#method.current">current</a> <a href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/1.65.0/src/core/convert/mod.rs.html#543">source</a><a href="#impl-Into%3CU%3E-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.65.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.65.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.65.0/src/core/convert/mod.rs.html#551">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.65.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
2023-02-11 06:48:57 -08:00
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.65.0/core/convert/trait.From.html" title="From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-LosslessTryInto%3CDst%3E-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/fixed/~1.11/src/fixed/traits.rs.html#3054">source</a><a href="#impl-LosslessTryInto%3CDst%3E-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;Src, Dst&gt; <a class="trait" href="https://docs.rs/fixed/~1.11/fixed/traits/trait.LosslessTryInto.html" title="trait fixed::traits::LosslessTryInto">LosslessTryInto</a>&lt;Dst&gt; for Src<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Dst: <a class="trait" href="https://docs.rs/fixed/~1.11/fixed/traits/trait.LosslessTryFrom.html" title="trait fixed::traits::LosslessTryFrom">LosslessTryFrom</a>&lt;Src&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lossless_try_into" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/fixed/~1.11/src/fixed/traits.rs.html#3058">source</a><a href="#method.lossless_try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/fixed/~1.11/fixed/traits/trait.LosslessTryInto.html#tymethod.lossless_try_into" class="fnname">lossless_try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.65.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Dst&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-LossyInto%3CDst%3E-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/fixed/~1.11/src/fixed/traits.rs.html#3105">source</a><a href="#impl-LossyInto%3CDst%3E-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;Src, Dst&gt; <a class="trait" href="https://docs.rs/fixed/~1.11/fixed/traits/trait.LossyInto.html" title="trait fixed::traits::LossyInto">LossyInto</a>&lt;Dst&gt; for Src<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Dst: <a class="trait" href="https://docs.rs/fixed/~1.11/fixed/traits/trait.LossyFrom.html" title="trait fixed::traits::LossyFrom">LossyFrom</a>&lt;Src&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lossy_into" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/fixed/~1.11/src/fixed/traits.rs.html#3109">source</a><a href="#method.lossy_into" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/fixed/~1.11/fixed/traits/trait.LossyInto.html#tymethod.lossy_into" class="fnname">lossy_into</a>(self) -&gt; Dst</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OverflowingAs-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/az/~1.2/src/az/lib.rs.html#897">source</a><a href="#impl-OverflowingAs-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://docs.rs/az/~1.2/az/trait.OverflowingAs.html" title="trait az::OverflowingAs">OverflowingAs</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.overflowing_as" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/az/~1.2/src/az/lib.rs.html#900-902">source</a><a href="#method.overflowing_as" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/az/~1.2/az/trait.OverflowingAs.html#tymethod.overflowing_as" class="fnname">overflowing_as</a>&lt;Dst&gt;(self) -&gt; (Dst, <a class="primitive" href="https://doc.rust-lang.org/1.65.0/std/primitive.bool.html">bool</a>)<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T:
<a href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#221">source</a><a href="#method.with_current_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fnname">with_current_subscriber</a>(self) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Attaches the current <a href="https://docs.rs/tracing/0.1.37/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> <a href="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
<a href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-WrappingAs-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/az/~1.2/src/az/lib.rs.html#818">source</a><a href="#impl-WrappingAs-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; <a class="trait" href="https://docs.rs/az/~1.2/az/trait.WrappingAs.html" title="trait az::WrappingAs">WrappingAs</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.wrapping_as" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/az/~1.2/src/az/lib.rs.html#821-823">source</a><a href="#method.wrapping_as" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/az/~1.2/az/trait.WrappingAs.html#tymethod.wrapping_as" class="fnname">wrapping_as</a>&lt;Dst&gt;(self) -&gt; Dst<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://docs.rs/az/~1.2/az/trait.WrappingCast.html" title="trait az::WrappingCast">WrappingCast</a>&lt;Dst&gt;,</span></h4></section></summary><div class='docblock'>Casts the value.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-WrappingCastFrom%3CSrc%3E-for-PerpPosition" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/az/~1.2/src/az/lib.rs.html#438">source</a><a href="#impl-WrappingCastFrom%3CSrc%3E-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;Src, Dst&gt; <a class="trait" href="https://docs.rs/az/~1.2/az/trait.WrappingCastFrom.html" title="trait az::WrappingCastFrom">WrappingCastFrom</a>&lt;Src&gt; for Dst<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Src: <a class="trait" href="https://docs.rs/az/~1.2/az/trait.WrappingCast.html" title="trait az::WrappingCast">WrappingCast</a>&lt;Dst&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.wrapping_cast_from" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/az/~1.2/src/az/lib.rs.html#441">source</a><a href="#method.wrapping_cast_from" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/az/~1.2/az/trait.WrappingCastFrom.html#tymethod.wrapping_cast_from" class="fnname">wrapping_cast_from</a>(src: Src) -&gt; Dst</h4></section></summary><div class='docblock'>Casts the value.</div></details></div></details><section id="impl-AnyBitPattern-for-PerpPosition" class="impl has-srclink"><a href="#impl-AnyBitPattern-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; AnyBitPattern for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Pod,</span></h3></section><section id="impl-NoUninit-for-PerpPosition" class="impl has-srclink"><a href="#impl-NoUninit-for-PerpPosition" class="anchor"></a><h3 class="code-header in-band">impl&lt;T&gt; NoUninit for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Pod,</span></h3></section></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mango_v4" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html>