mango-v4/rs/doc/mango_v4/health/index.html

1 line
7.6 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `health` mod in crate `mango_v4`."><title>mango_v4::health - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-c4dbdcde0fbd8430.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-db279b6232be9c13.css"><link rel="stylesheet" disabled href="../../static.files/dark-cf923f49f397b216.css"><link rel="stylesheet" disabled href="../../static.files/ayu-be46fdc453a55015.css"><script src="../../static.files/storage-3891ce972e3a2bf8.js"></script><script defer src="../../static.files/main-98a684e84ae5b08b.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="logo-container" href="../../mango_v4/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../mango_v4/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Module health</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">mango_v4</a>::<wbr><a class="mod" href="#">health</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/mango_v4/health/mod.rs.html#1-9">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.FixedOrderAccountRetriever.html" title="struct mango_v4::health::FixedOrderAccountRetriever">FixedOrderAccountRetriever</a></div><div class="desc docblock-short">Assumes the account infos needed for the health computation follow a strict order.</div></li><li><div class="item-name"><a class="struct" href="struct.HealthCache.html" title="struct mango_v4::health::HealthCache">HealthCache</a></div></li><li><div class="item-name"><a class="struct" href="struct.PerpInfo.html" title="struct mango_v4::health::PerpInfo">PerpInfo</a></div></li><li><div class="item-name"><a class="struct" href="struct.Prices.html" title="struct mango_v4::health::Prices">Prices</a></div><div class="desc docblock-short">Information about prices for a bank or perp market.</div></li><li><div class="item-name"><a class="struct" href="struct.ScanningAccountRetriever.html" title="struct mango_v4::health::ScanningAccountRetriever">ScanningAccountRetriever</a></div><div class="desc docblock-short">Takes a list of account infos containing</div></li><li><div class="item-name"><a class="struct" href="struct.Serum3Info.html" title="struct mango_v4::health::Serum3Info">Serum3Info</a></div></li><li><div class="item-name"><a class="struct" href="struct.TokenInfo.html" title="struct mango_v4::health::TokenInfo">TokenInfo</a></div></li></ul><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.HealthType.html" title="enum mango_v4::health::HealthType">HealthType</a></div><div class="desc docblock-short">There are three types of health:</div></li></ul><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.AccountRetriever.html" title="trait mango_v4::health::AccountRetriever">AccountRetriever</a></div><div class="desc docblock-short">This trait abstracts how to find accounts needed for the health computation.</div></li></ul><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.compute_health.html" title="fn mango_v4::health::compute_health">compute_health</a></div><div class="desc docblock-short">Compute health with an arbitrary AccountRetriever</div></li><li><div class="item-name"><a class="fn" href="fn.compute_health_from_fixed_accounts.html" title="fn mango_v4::health::compute_health_from_fixed_accounts">compute_health_from_fixed_accounts</a></div><div class="desc docblock-short">Computes health for a mango account given a set of account infos</div></li><li><div class="item-name"><a class="fn" href="fn.new_fixed_order_account_retriever.html" title="fn mango_v4::health::new_fixed_order_account_retriever">new_fixed_order_account_retriever</a></div></li><li><div class="item-name"><a class="fn" href="fn.new_health_cache.html" title="fn mango_v4::health::new_health_cache">new_health_cache</a></div><div class="desc docblock-short">Generate a HealthCache for an account and its health accounts.</div></li></ul></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mango_v4" data-themes="" data-resource-suffix="" data-rustdoc-version="1.69.0 (84c898d65 2023-04-16)" data-search-js="search-8a59a8356673ec1f.js" data-settings-js="settings-f0c5c39777a9a2f6.js" data-settings-css="settings-0bcba95ff279c1db.css" ></div></body></html>