<!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 `SessionState` trait in crate `solicit`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, SessionState">

    <title>solicit::http::session::SessionState - Rust</title>

    <link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
    <link rel="stylesheet" type="text/css" href="../../../main.css">
    

    
    
</head>
<body class="rustdoc">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        
        <p class='location'><a href='../../index.html'>solicit</a>::<wbr><a href='../index.html'>http</a>::<wbr><a href='index.html'>session</a></p><script>window.sidebarCurrent = {name: 'SessionState', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
    </nav>

    <nav class="sub">
        <form class="search-form js-only">
            <div class="search-container">
                <input class="search-input" name="search"
                       autocomplete="off"
                       placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
                       type="search">
            </div>
        </form>
    </nav>

    <section id='main' class="content trait">
<h1 class='fqn'><span class='in-band'>Trait <a href='../../index.html'>solicit</a>::<wbr><a href='../index.html'>http</a>::<wbr><a href='index.html'>session</a>::<wbr><a class='trait' href=''>SessionState</a></span><span class='out-of-band'><span id='render-detail'>
                   <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                       [<span class='inner'>&#x2212;</span>]
                   </a>
               </span><a id='src-996' class='srclink' href='../../../src/solicit/http/session.rs.html#57-90' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait SessionState {
    type <a href='#associatedtype.Stream' class='type'>Stream</a>: <a class='trait' href='../../../solicit/http/session/trait.Stream.html' title='solicit::http::session::Stream'>Stream</a>;
    fn <a href='#tymethod.insert_stream' class='fnname'>insert_stream</a>(&amp;mut self, stream: Self::Stream);
    fn <a href='#tymethod.get_stream_ref' class='fnname'>get_stream_ref</a>(&amp;self, stream_id: <a class='type' href='../../../solicit/http/type.StreamId.html' title='solicit::http::StreamId'>StreamId</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;&amp;Self::Stream&gt;;
    fn <a href='#tymethod.get_stream_mut' class='fnname'>get_stream_mut</a>(&amp;mut self, stream_id: <a class='type' href='../../../solicit/http/type.StreamId.html' title='solicit::http::StreamId'>StreamId</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;&amp;mut Self::Stream&gt;;
    fn <a href='#tymethod.remove_stream' class='fnname'>remove_stream</a>(&amp;mut self, stream_id: <a class='type' href='../../../solicit/http/type.StreamId.html' title='solicit::http::StreamId'>StreamId</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;Self::Stream&gt;;
    fn <a href='#tymethod.iter' class='fnname'>iter</a>(&amp;mut self) -&gt; <a class='struct' href='../../../solicit/http/session/struct.StreamIter.html' title='solicit::http::session::StreamIter'>StreamIter</a>&lt;Self::Stream&gt;;

    fn <a href='#method.get_closed' class='fnname'>get_closed</a>(&amp;mut self) -&gt; <a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a>&lt;Self::Stream&gt; { ... }
}</pre><div class='docblock'><p>A trait defining a set of methods for accessing and influencing an HTTP/2 session&#39;s state.</p>

<p>This trait is tightly coupled to a <code>Stream</code>-based session layer implementation. Particular
implementations are additionally tightly coupled to one particular <code>Stream</code> implementation.</p>

<h1 id='note' class='section-header'><a href='#note'>Note</a></h1>
<p>Clients built on top of the raw <code>HttpConnection</code> + <code>Session</code> can still exist without using
this trait; however, it is included for convenience, as most session implementations <em>will</em>
want to keep track of similar things in the session&#39;s state.</p>
</div>
            <h2 id='associated-types'>Associated Types</h2>
            <div class='methods'>
        <h3 id='associatedtype.Stream' class='method stab '><code>type <a href='#associatedtype.Stream' class='type'>Stream</a>: <a class='trait' href='../../../solicit/http/session/trait.Stream.html' title='solicit::http::session::Stream'>Stream</a></code></h3><div class='docblock'><p>The type of the <code>Stream</code> that the <code>SessionState</code> manages.</p>
</div></div>
            <h2 id='required-methods'>Required Methods</h2>
            <div class='methods'>
        <h3 id='tymethod.insert_stream' class='method stab '><code>fn <a href='#tymethod.insert_stream' class='fnname'>insert_stream</a>(&amp;mut self, stream: Self::Stream)</code></h3><div class='docblock'><p>Inserts the given <code>Stream</code> into the session&#39;s state, starting to track it.</p>
</div><h3 id='tymethod.get_stream_ref' class='method stab '><code>fn <a href='#tymethod.get_stream_ref' class='fnname'>get_stream_ref</a>(&amp;self, stream_id: <a class='type' href='../../../solicit/http/type.StreamId.html' title='solicit::http::StreamId'>StreamId</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;&amp;Self::Stream&gt;</code></h3><div class='docblock'><p>Returns a reference to a <code>Stream</code> with the given <code>StreamId</code>, if it is found in the current
session.</p>
</div><h3 id='tymethod.get_stream_mut' class='method stab '><code>fn <a href='#tymethod.get_stream_mut' class='fnname'>get_stream_mut</a>(&amp;mut self, stream_id: <a class='type' href='../../../solicit/http/type.StreamId.html' title='solicit::http::StreamId'>StreamId</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;&amp;mut Self::Stream&gt;</code></h3><div class='docblock'><p>Returns a mutable reference to a <code>Stream</code> with the given <code>StreamId</code>, if it is found in the
current session.</p>
</div><h3 id='tymethod.remove_stream' class='method stab '><code>fn <a href='#tymethod.remove_stream' class='fnname'>remove_stream</a>(&amp;mut self, stream_id: <a class='type' href='../../../solicit/http/type.StreamId.html' title='solicit::http::StreamId'>StreamId</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;Self::Stream&gt;</code></h3><div class='docblock'><p>Removes the stream with the given <code>StreamId</code> from the session. If the stream was found in
the session, it is returned in the result.</p>
</div><h3 id='tymethod.iter' class='method stab '><code>fn <a href='#tymethod.iter' class='fnname'>iter</a>(&amp;mut self) -&gt; <a class='struct' href='../../../solicit/http/session/struct.StreamIter.html' title='solicit::http::session::StreamIter'>StreamIter</a>&lt;Self::Stream&gt;</code></h3><div class='docblock'><p>Returns an iterator over the streams currently found in the session.</p>
</div></div>
            <h2 id='provided-methods'>Provided Methods</h2>
            <div class='methods'>
        <h3 id='method.get_closed' class='method stab '><code>fn <a href='#method.get_closed' class='fnname'>get_closed</a>(&amp;mut self) -&gt; <a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a>&lt;Self::Stream&gt;</code></h3><div class='docblock'><p>Returns all streams that are closed and tracked by the session state.</p>

<p>The streams are moved out of the session state.</p>

<p>The default implementations relies on the <code>iter</code> implementation to find the closed streams
first and then calls <code>remove_stream</code> on all of them.</p>
</div></div>
        <h2 id='implementors'>Implementors</h2>
        <ul class='item-list' id='implementors-list'>
    <li><code>impl&lt;S&gt; SessionState for <a class='struct' href='../../../solicit/http/session/struct.DefaultSessionState.html' title='solicit::http::session::DefaultSessionState'>DefaultSessionState</a>&lt;S&gt; <span class='where'>where S: <a class='trait' href='../../../solicit/http/session/trait.Stream.html' title='solicit::http::session::Stream'>Stream</a></span></code></li>
</ul><script type="text/javascript" async
                         src="../../../implementors/solicit/http/session/trait.SessionState.js">
                 </script></section>
    <section id='search' class="content hidden"></section>

    <section class="footer"></section>

    <aside id="help" class="hidden">
        <div>
            <h1 class="hidden">Help</h1>

            <div class="shortcuts">
                <h2>Keyboard Shortcuts</h2>

                <dl>
                    <dt>?</dt>
                    <dd>Show this help dialog</dd>
                    <dt>S</dt>
                    <dd>Focus the search field</dd>
                    <dt>&larrb;</dt>
                    <dd>Move up in search results</dd>
                    <dt>&rarrb;</dt>
                    <dd>Move down in search results</dd>
                    <dt>&#9166;</dt>
                    <dd>Go to active search result</dd>
                    <dt>+</dt>
                    <dd>Collapse/expand all sections</dd>
                </dl>
            </div>

            <div class="infos">
                <h2>Search Tricks</h2>

                <p>
                    Prefix searches with a type followed by a colon (e.g.
                    <code>fn:</code>) to restrict the search to a given type.
                </p>

                <p>
                    Accepted types are: <code>fn</code>, <code>mod</code>,
                    <code>struct</code>, <code>enum</code>,
                    <code>trait</code>, <code>type</code>, <code>macro</code>,
                    and <code>const</code>.
                </p>

                <p>
                    Search functions by type signature (e.g.
                    <code>vec -> usize</code> or <code>* -> vec</code>)
                </p>
            </div>
        </div>
    </aside>

    

    <script>
        window.rootPath = "../../../";
        window.currentCrate = "solicit";
        window.playgroundUrl = "";
    </script>
    <script src="../../../jquery.js"></script>
    <script src="../../../main.js"></script>
    
    <script defer src="../../../search-index.js"></script>
</body>
</html>