mango-v4/rs/doc/src/mango_v4_client/util.rs.html

313 lines
17 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="Source of the Rust file `lib/client/src/util.rs`."><title>util.rs - source</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-ba5701c5741a7b69.css" id="mainThemeStyle"><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mango_v4_client" data-themes="" data-resource-suffix="" data-rustdoc-version="1.70.0 (90c541806 2023-05-31)" data-search-js="search-e077946657036a58.js" data-settings-js="settings-298e1ea74db45b39.js" data-settings-css="settings-7bfb4c59cc6bc502.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ></div><script src="../../static.files/storage-62ce34ea385b278a.js"></script><script defer src="../../static.files/source-script-905937fbbdc8e9ea.js"></script><script defer src="../../source-files.js"></script><script defer src="../../static.files/main-f61008743c98d196.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-1097f8e92a01e3cf.css"><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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../mango_v4_client/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><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="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
</pre></div><pre class="rust"><code><span class="kw">use </span>solana_sdk::compute_budget::ComputeBudgetInstruction;
<span class="kw">use </span>solana_sdk::instruction::Instruction;
<span class="kw">use </span>anchor_lang::prelude::{AccountMeta, Pubkey};
<span class="kw">use </span>anyhow::Context;
<span class="doccomment">/// Some Result&lt;&gt; types don&#39;t convert to anyhow::Result nicely. Force them through stringification.
</span><span class="kw">pub trait </span>AnyhowWrap {
<span class="kw">type </span>Value;
<span class="kw">fn </span>map_err_anyhow(<span class="self">self</span>) -&gt; anyhow::Result&lt;<span class="self">Self</span>::Value&gt;;
}
<span class="kw">impl</span>&lt;T, E: std::fmt::Debug&gt; AnyhowWrap <span class="kw">for </span><span class="prelude-ty">Result</span>&lt;T, E&gt; {
<span class="kw">type </span>Value = T;
<span class="kw">fn </span>map_err_anyhow(<span class="self">self</span>) -&gt; anyhow::Result&lt;<span class="self">Self</span>::Value&gt; {
<span class="self">self</span>.map_err(|err| <span class="macro">anyhow::anyhow!</span>(<span class="string">&quot;{:?}&quot;</span>, err))
}
}
<span class="doccomment">/// Push to an async_channel::Sender and ignore if the channel is full
</span><span class="kw">pub trait </span>AsyncChannelSendUnlessFull&lt;T&gt; {
<span class="doccomment">/// Send a message if the channel isn&#39;t full
</span><span class="kw">fn </span>send_unless_full(<span class="kw-2">&amp;</span><span class="self">self</span>, msg: T) -&gt; anyhow::Result&lt;()&gt;;
}
<span class="kw">impl</span>&lt;T&gt; AsyncChannelSendUnlessFull&lt;T&gt; <span class="kw">for </span>async_channel::Sender&lt;T&gt; {
<span class="kw">fn </span>send_unless_full(<span class="kw-2">&amp;</span><span class="self">self</span>, msg: T) -&gt; anyhow::Result&lt;()&gt; {
<span class="kw">use </span>async_channel::<span class="kw-2">*</span>;
<span class="kw">match </span><span class="self">self</span>.try_send(msg) {
<span class="prelude-val">Ok</span>(()) =&gt; <span class="prelude-val">Ok</span>(()),
<span class="prelude-val">Err</span>(TrySendError::Closed(<span class="kw">_</span>)) =&gt; <span class="prelude-val">Err</span>(<span class="macro">anyhow::format_err!</span>(<span class="string">&quot;channel is closed&quot;</span>)),
<span class="prelude-val">Err</span>(TrySendError::Full(<span class="kw">_</span>)) =&gt; <span class="prelude-val">Ok</span>(()),
}
}
}
<span class="kw">impl</span>&lt;T&gt; AsyncChannelSendUnlessFull&lt;T&gt; <span class="kw">for </span>tokio::sync::mpsc::Sender&lt;T&gt; {
<span class="kw">fn </span>send_unless_full(<span class="kw-2">&amp;</span><span class="self">self</span>, msg: T) -&gt; anyhow::Result&lt;()&gt; {
<span class="kw">use </span>tokio::sync::mpsc::<span class="kw-2">*</span>;
<span class="kw">match </span><span class="self">self</span>.try_send(msg) {
<span class="prelude-val">Ok</span>(()) =&gt; <span class="prelude-val">Ok</span>(()),
<span class="prelude-val">Err</span>(error::TrySendError::Closed(<span class="kw">_</span>)) =&gt; <span class="prelude-val">Err</span>(<span class="macro">anyhow::format_err!</span>(<span class="string">&quot;channel is closed&quot;</span>)),
<span class="prelude-val">Err</span>(error::TrySendError::Full(<span class="kw">_</span>)) =&gt; <span class="prelude-val">Ok</span>(()),
}
}
}
<span class="doccomment">/// Like tokio::time::interval(), but with Delay as default MissedTickBehavior
///
/// The default (Burst) means that if the time between tick() calls is longer
/// than `period` there&#39;ll be a burst of catch-up ticks.
///
/// This Interval guarantees that when tick() returns, at least `period` will have
/// elapsed since the last return. That way it&#39;s more appropriate for jobs that
/// don&#39;t need to catch up.
</span><span class="kw">pub fn </span>delay_interval(period: std::time::Duration) -&gt; tokio::time::Interval {
<span class="kw">let </span><span class="kw-2">mut </span>interval = tokio::time::interval(period);
interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
interval
}
<span class="doccomment">/// Convenience function used in binaries to set up the fmt tracing_subscriber,
/// with cololring enabled only if logging to a terminal and with EnvFilter.
</span><span class="kw">pub fn </span>tracing_subscriber_init() {
<span class="kw">let </span>format = tracing_subscriber::fmt::format().with_ansi(atty::is(atty::Stream::Stdout));
tracing_subscriber::fmt()
.with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
.event_format(format)
.init();
}
<span class="kw">pub async fn </span>http_error_handling&lt;T: serde::de::DeserializeOwned&gt;(
response: reqwest::Response,
) -&gt; anyhow::Result&lt;T&gt; {
<span class="kw">let </span>status = response.status();
<span class="kw">let </span>response_text = response
.text()
.<span class="kw">await
</span>.context(<span class="string">&quot;awaiting body of http request&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">if </span>!status.is_success() {
<span class="macro">anyhow::bail!</span>(<span class="string">&quot;http request failed, status: {status}, body: {response_text}&quot;</span>);
}
serde_json::from_str::&lt;T&gt;(<span class="kw-2">&amp;</span>response_text)
.with_context(|| <span class="macro">format!</span>(<span class="string">&quot;response has unexpected format, body: {response_text}&quot;</span>))
}
<span class="kw">pub fn </span>to_readonly_account_meta(pubkey: Pubkey) -&gt; AccountMeta {
AccountMeta {
pubkey,
is_writable: <span class="bool-val">false</span>,
is_signer: <span class="bool-val">false</span>,
}
}
<span class="kw">pub fn </span>to_writable_account_meta(pubkey: Pubkey) -&gt; AccountMeta {
AccountMeta {
pubkey,
is_writable: <span class="bool-val">true</span>,
is_signer: <span class="bool-val">false</span>,
}
}
<span class="attr">#[derive(Default, Clone)]
</span><span class="kw">pub struct </span>PreparedInstructions {
<span class="kw">pub </span>instructions: Vec&lt;Instruction&gt;,
<span class="kw">pub </span>cu: u32,
}
<span class="kw">impl </span>PreparedInstructions {
<span class="kw">pub fn </span>new() -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
instructions: <span class="macro">vec!</span>[],
cu: <span class="number">0</span>,
}
}
<span class="kw">pub fn </span>from_vec(instructions: Vec&lt;Instruction&gt;, cu: u32) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{ instructions, cu }
}
<span class="kw">pub fn </span>from_single(instruction: Instruction, cu: u32) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
instructions: <span class="macro">vec!</span>[instruction],
cu,
}
}
<span class="kw">pub fn </span>push(<span class="kw-2">&amp;mut </span><span class="self">self</span>, ix: Instruction, cu: u32) {
<span class="self">self</span>.instructions.push(ix);
<span class="self">self</span>.cu += cu;
}
<span class="kw">pub fn </span>append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, <span class="kw-2">mut </span>other: <span class="self">Self</span>) {
<span class="self">self</span>.instructions.append(<span class="kw-2">&amp;mut </span>other.instructions);
<span class="self">self</span>.cu += other.cu;
}
<span class="kw">pub fn </span>to_instructions(<span class="self">self</span>) -&gt; Vec&lt;Instruction&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>ixs = <span class="self">self</span>.instructions;
ixs.insert(<span class="number">0</span>, ComputeBudgetInstruction::set_compute_unit_limit(<span class="self">self</span>.cu));
ixs
}
<span class="kw">pub fn </span>is_empty(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.instructions.is_empty()
}
<span class="kw">pub fn </span>clear(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.instructions.clear();
<span class="self">self</span>.cu = <span class="number">0</span>;
}
<span class="kw">pub fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.instructions.len()
}
}
</code></pre></div></section></main></body></html>