mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
34 lines
8.7 KiB
HTML
34 lines
8.7 KiB
HTML
<!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="Interface used by smart transports."><title>SmartSubtransport in git2::transport - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="git2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.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 trait"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../git2/index.html">git2</a><span class="version">0.18.3</span></h2></div><h2 class="location"><a href="#">SmartSubtransport</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.action">action</a></li><li><a href="#tymethod.close">close</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In git2::transport</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../git2/all.html" title="show sidebar"></a></div><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" tabindex="-1"><a href="../../help.html" title="help">?</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>Trait <a href="../index.html">git2</a>::<wbr><a href="index.html">transport</a>::<wbr><a class="trait" href="#">SmartSubtransport</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="src" href="../../src/git2/transport.rs.html#35-54">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait SmartSubtransport: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static {
|
||
// Required methods
|
||
fn <a href="#tymethod.action" class="fn">action</a>(
|
||
&self,
|
||
url: &<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>,
|
||
action: <a class="enum" href="enum.Service.html" title="enum git2::transport::Service">Service</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.78.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="trait.SmartSubtransportStream.html" title="trait git2::transport::SmartSubtransportStream">SmartSubtransportStream</a>>, <a class="struct" href="../struct.Error.html" title="struct git2::Error">Error</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.close" class="fn">close</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <a class="struct" href="../struct.Error.html" title="struct git2::Error">Error</a>>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Interface used by smart transports.</p>
|
||
<p>The full-fledged definition of transports has to deal with lots of
|
||
nitty-gritty details of the git protocol, but “smart transports” largely
|
||
only need to deal with read() and write() of data over a channel.</p>
|
||
<p>A smart subtransport is contained within an instance of a smart transport
|
||
and is delegated to in order to actually conduct network activity to push or
|
||
pull data from a remote.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.action" class="method"><a class="src rightside" href="../../src/git2/transport.rs.html#42-43">source</a><h4 class="code-header">fn <a href="#tymethod.action" class="fn">action</a>(
|
||
&self,
|
||
url: &<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>,
|
||
action: <a class="enum" href="enum.Service.html" title="enum git2::transport::Service">Service</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.78.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="trait.SmartSubtransportStream.html" title="trait git2::transport::SmartSubtransportStream">SmartSubtransportStream</a>>, <a class="struct" href="../struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Indicates that this subtransport will be performing the specified action
|
||
on the specified URL.</p>
|
||
<p>This function is responsible for making any network connections and
|
||
returns a stream which can be read and written from in order to
|
||
negotiate the git protocol.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.close" class="method"><a class="src rightside" href="../../src/git2/transport.rs.html#53">source</a><h4 class="code-header">fn <a href="#tymethod.close" class="fn">close</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <a class="struct" href="../struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Terminates a connection with the remote.</p>
|
||
<p>Each subtransport is guaranteed a call to close() between calls to
|
||
action(), except for the following two natural progressions of actions
|
||
against a constant URL.</p>
|
||
<ol>
|
||
<li>UploadPackLs -> UploadPack</li>
|
||
<li>ReceivePackLs -> ReceivePack</li>
|
||
</ol>
|
||
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/git2/transport/trait.SmartSubtransport.js" async></script></section></div></main></body></html> |