You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
obws/coverage/src/client/sources.rs.html

1 line
15 KiB
HTML

<!doctype html><html><head><meta name='viewport' content='width=device-width,initial-scale=1'><meta charset='UTF-8'><link rel='stylesheet' type='text/css' href='../../../style.css'></head><body><h2>Coverage Report</h2><h4>Created: 2022-07-04 16:17</h4><div class='centered'><table><div class='source-name-title'><pre>src/client/sources.rs</pre></div><tr><td><pre>Line</pre></td><td><pre>Count</pre></td><td><pre>Source</pre></td></td></tr><tr><td class='line-number'><a name='L1' href='#L1'><pre>1</pre></a></td><td class='uncovered-line'></td><td class='code'><pre>use super::Client;</pre></td></tr><tr><td class='line-number'><a name='L2' href='#L2'><pre>2</pre></a></td><td class='uncovered-line'></td><td class='code'><pre>use crate::{</pre></td></tr><tr><td class='line-number'><a name='L3' href='#L3'><pre>3</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> requests::sources::{Request, SaveScreenshot, TakeScreenshot},</pre></td></tr><tr><td class='line-number'><a name='L4' href='#L4'><pre>4</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> responses::sources as responses,</pre></td></tr><tr><td class='line-number'><a name='L5' href='#L5'><pre>5</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> Result,</pre></td></tr><tr><td class='line-number'><a name='L6' href='#L6'><pre>6</pre></a></td><td class='uncovered-line'></td><td class='code'><pre>};</pre></td></tr><tr><td class='line-number'><a name='L7' href='#L7'><pre>7</pre></a></td><td class='uncovered-line'></td><td class='code'><pre></pre></td></tr><tr><td class='line-number'><a name='L8' href='#L8'><pre>8</pre></a></td><td class='uncovered-line'></td><td class='code'><pre>/// API functions related to sources.</pre></td></tr><tr><td class='line-number'><a name='L9' href='#L9'><pre>9</pre></a></td><td class='uncovered-line'></td><td class='code'><pre>pub struct Sources&lt;&apos;a&gt; {</pre></td></tr><tr><td class='line-number'><a name='L10' href='#L10'><pre>10</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> pub(super) client: &amp;&apos;a Client,</pre></td></tr><tr><td class='line-number'><a name='L11' href='#L11'><pre>11</pre></a></td><td class='uncovered-line'></td><td class='code'><pre>}</pre></td></tr><tr><td class='line-number'><a name='L12' href='#L12'><pre>12</pre></a></td><td class='uncovered-line'></td><td class='code'><pre></pre></td></tr><tr><td class='line-number'><a name='L13' href='#L13'><pre>13</pre></a></td><td class='uncovered-line'></td><td class='code'><pre>impl&lt;&apos;a&gt; Sources&lt;&apos;a&gt; {</pre></td></tr><tr><td class='line-number'><a name='L14' href='#L14'><pre>14</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// Gets the active and show state of a source.</pre></td></tr><tr><td class='line-number'><a name='L15' href='#L15'><pre>15</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> pub async fn active(&amp;self, name: &amp;str) -&gt; Result&lt;responses::SourceActive&gt; {</pre><div class='expansion-view'><div class='centered'><table><div class='source-name-title'><pre>&lt;obws::client::sources::Sources&gt;::active</pre></div><tr><td><pre>Line</pre></td><td><pre>Count</pre></td><td><pre>Source</pre></td></tr><tr><td class='line-number'><a name='L15' href='#L15'><pre>15</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> pub async fn active(&amp;self, name: &amp;str) -&gt; Result&lt;responses::SourceActive&gt; {</pre></td></tr></table></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::active</pre></div></div></td></tr><tr><td class='line-number'><a name='L16' href='#L16'><pre>16</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre> <div class='tooltip'>self.client.send_message(Request::Active { name })<span class='tooltip-content'>1</span></div>.await</pre></td></tr><tr><td class='line-number'><a name='L17' href='#L17'><pre>17</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> }</pre><div class='expansion-view'><div class='centered'><table><div class='source-name-title'><pre>&lt;obws::client::sources::Sources&gt;::active::{closure#0}</pre></div><tr><td><pre>Line</pre></td><td><pre>Count</pre></td><td><pre>Source</pre></td></tr><tr><td class='line-number'><a name='L16' href='#L16'><pre>16</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre> <div class='tooltip'>self.client.send_message(Request::Active { name })<span class='tooltip-content'>1</span></div>.await</pre></td></tr><tr><td class='line-number'><a name='L17' href='#L17'><pre>17</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> }</pre></td></tr></table></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::active::{closure#0}</pre></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::active::{closure#0}</pre></div></div></td></tr><tr><td class='line-number'><a name='L18' href='#L18'><pre>18</pre></a></td><td class='uncovered-line'></td><td class='code'><pre></pre></td></tr><tr><td class='line-number'><a name='L19' href='#L19'><pre>19</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// Gets a Base64-encoded screenshot of a source.</pre></td></tr><tr><td class='line-number'><a name='L20' href='#L20'><pre>20</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> ///</pre></td></tr><tr><td class='line-number'><a name='L21' href='#L21'><pre>21</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// The [`TakeScreenshot::width`] and [`TakeScreenshot::height`] parameters are treated as</pre></td></tr><tr><td class='line-number'><a name='L22' href='#L22'><pre>22</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// &quot;scale to inner&quot;, meaning the smallest ratio will be used and the aspect ratio of the</pre></td></tr><tr><td class='line-number'><a name='L23' href='#L23'><pre>23</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// original resolution is kept. If [`TakeScreenshot::width`] and [`TakeScreenshot::height`] are</pre></td></tr><tr><td class='line-number'><a name='L24' href='#L24'><pre>24</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// not specified, the compressed image will use the full resolution of the source.</pre></td></tr><tr><td class='line-number'><a name='L25' href='#L25'><pre>25</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> pub async fn take_screenshot(&amp;self, settings: TakeScreenshot&lt;&apos;_&gt;) -&gt; Result&lt;String&gt; {</pre><div class='expansion-view'><div class='centered'><table><div class='source-name-title'><pre>&lt;obws::client::sources::Sources&gt;::take_screenshot</pre></div><tr><td><pre>Line</pre></td><td><pre>Count</pre></td><td><pre>Source</pre></td></tr><tr><td class='line-number'><a name='L25' href='#L25'><pre>25</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> pub async fn take_screenshot(&amp;self, settings: TakeScreenshot&lt;&apos;_&gt;) -&gt; Result&lt;String&gt; {</pre></td></tr></table></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::take_screenshot</pre></div></div></td></tr><tr><td class='line-number'><a name='L26' href='#L26'><pre>26</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> self.client</pre></td></tr><tr><td class='line-number'><a name='L27' href='#L27'><pre>27</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre> .send_message::&lt;_, responses::ImageData&gt;(Request::TakeScreenshot(settings))</pre></td></tr><tr><td class='line-number'><a name='L28' href='#L28'><pre>28</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre> .await</pre></td></tr><tr><td class='line-number'><a name='L29' href='#L29'><pre>29</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> .map(|id| id.image_data)</pre><div class='expansion-view'><div class='centered'><table><div class='source-name-title'><pre>&lt;obws::client::sources::Sources&gt;::take_screenshot::{closure#0}::{closure#0}</pre></div><tr><td><pre>Line</pre></td><td><pre>Count</pre></td><td><pre>Source</pre></td></tr><tr><td class='line-number'><a name='L29' href='#L29'><pre>29</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> .map(|id| id.image_data)</pre></td></tr></table></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::take_screenshot::{closure#0}::{closure#0}</pre></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::take_screenshot::{closure#0}::{closure#0}</pre></div></div></td></tr><tr><td class='line-number'><a name='L30' href='#L30'><pre>30</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> }</pre><div class='expansion-view'><div class='centered'><table><div class='source-name-title'><pre>&lt;obws::client::sources::Sources&gt;::take_screenshot::{closure#0}</pre></div><tr><td><pre>Line</pre></td><td><pre>Count</pre></td><td><pre>Source</pre></td></tr><tr><td class='line-number'><a name='L26' href='#L26'><pre>26</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> self.client</pre></td></tr><tr><td class='line-number'><a name='L27' href='#L27'><pre>27</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre> .send_message::&lt;_, responses::ImageData&gt;(Request::TakeScreenshot(settings))</pre></td></tr><tr><td class='line-number'><a name='L28' href='#L28'><pre>28</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre> .await</pre></td></tr><tr><td class='line-number'><a name='L29' href='#L29'><pre>29</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> .map(|id| id.image_data)</pre></td></tr><tr><td class='line-number'><a name='L30' href='#L30'><pre>30</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> }</pre></td></tr></table></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::take_screenshot::{closure#0}</pre></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::take_screenshot::{closure#0}</pre></div></div></td></tr><tr><td class='line-number'><a name='L31' href='#L31'><pre>31</pre></a></td><td class='uncovered-line'></td><td class='code'><pre></pre></td></tr><tr><td class='line-number'><a name='L32' href='#L32'><pre>32</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// Saves a screenshot of a source to the file system.</pre></td></tr><tr><td class='line-number'><a name='L33' href='#L33'><pre>33</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> ///</pre></td></tr><tr><td class='line-number'><a name='L34' href='#L34'><pre>34</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// The [`SaveScreenshot::width`] and [`SaveScreenshot::height`] parameters are treated as</pre></td></tr><tr><td class='line-number'><a name='L35' href='#L35'><pre>35</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// &quot;scale to inner&quot;, meaning the smallest ratio will be used and the aspect ratio of the</pre></td></tr><tr><td class='line-number'><a name='L36' href='#L36'><pre>36</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// original resolution is kept. If [`SaveScreenshot::width`] and [`SaveScreenshot::height`] are</pre></td></tr><tr><td class='line-number'><a name='L37' href='#L37'><pre>37</pre></a></td><td class='uncovered-line'></td><td class='code'><pre> /// not specified, the compressed image will use the full resolution of the source.</pre></td></tr><tr><td class='line-number'><a name='L38' href='#L38'><pre>38</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> pub async fn save_screenshot(&amp;self, settings: SaveScreenshot&lt;&apos;_&gt;) -&gt; Result&lt;()&gt; {</pre><div class='expansion-view'><div class='centered'><table><div class='source-name-title'><pre>&lt;obws::client::sources::Sources&gt;::save_screenshot</pre></div><tr><td><pre>Line</pre></td><td><pre>Count</pre></td><td><pre>Source</pre></td></tr><tr><td class='line-number'><a name='L38' href='#L38'><pre>38</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> pub async fn save_screenshot(&amp;self, settings: SaveScreenshot&lt;&apos;_&gt;) -&gt; Result&lt;()&gt; {</pre></td></tr></table></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::save_screenshot</pre></div></div></td></tr><tr><td class='line-number'><a name='L39' href='#L39'><pre>39</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> self.client</pre></td></tr><tr><td class='line-number'><a name='L40' href='#L40'><pre>40</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre> .send_message(Request::SaveScreenshot(settings))</pre></td></tr><tr><td class='line-number'><a name='L41' href='#L41'><pre>41</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre> .await</pre></td></tr><tr><td class='line-number'><a name='L42' href='#L42'><pre>42</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> }</pre><div class='expansion-view'><div class='centered'><table><div class='source-name-title'><pre>&lt;obws::client::sources::Sources&gt;::save_screenshot::{closure#0}</pre></div><tr><td><pre>Line</pre></td><td><pre>Count</pre></td><td><pre>Source</pre></td></tr><tr><td class='line-number'><a name='L39' href='#L39'><pre>39</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> self.client</pre></td></tr><tr><td class='line-number'><a name='L40' href='#L40'><pre>40</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre> .send_message(Request::SaveScreenshot(settings))</pre></td></tr><tr><td class='line-number'><a name='L41' href='#L41'><pre>41</pre></a></td><td class='covered-line'><pre>2</pre></td><td class='code'><pre> .await</pre></td></tr><tr><td class='line-number'><a name='L42' href='#L42'><pre>42</pre></a></td><td class='covered-line'><pre>1</pre></td><td class='code'><pre> }</pre></td></tr></table></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::save_screenshot::{closure#0}</pre></div></div><div class='expansion-view'><div class='source-name-title'><pre>Unexecuted instantiation: &lt;obws::client::sources::Sources&gt;::save_screenshot::{closure#0}</pre></div></div></td></tr><tr><td class='line-number'><a name='L43' href='#L43'><pre>43</pre></a></td><td class='uncovered-line'></td><td class='code'><pre>}</pre></td></tr></table></div></body></html>