1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
//! An implementation of the `git` transport layer, abstracting over all of its [versions][Protocol], providing
//! [`connect()`] to establish a connection given a repository URL.
//!
//! All git transports are supported, including `ssh`, `git`, `http` and `https`, as well as local repository paths.
//! ## Feature Flags
#![cfg_attr(
feature = "document-features",
cfg_attr(doc, doc = ::document_features::document_features!())
)]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![deny(missing_docs, rust_2018_idioms)]
#![forbid(unsafe_code)]
#[cfg(feature = "async-trait")]
pub use async_trait;
pub use bstr;
#[cfg(feature = "futures-io")]
pub use futures_io;
pub use gix_packetline as packetline;
/// The version of the way client and server communicate.
#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
#[allow(missing_docs)]
pub enum Protocol {
/// Version 1 was the first one conceived, is stateful, and our implementation was seen to cause deadlocks. Prefer V2
V1 = 1,
/// A command-based and stateless protocol with clear semantics, and the one to use assuming the server isn't very old.
/// This is the default.
V2 = 2,
}
impl Default for Protocol {
fn default() -> Self {
Protocol::V2
}
}
/// The kind of service to invoke on the client or the server side.
#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
pub enum Service {
/// The service sending packs from a server to the client. Used for fetching pack data.
UploadPack,
/// The service receiving packs produced by the client, who sends a pack to the server.
ReceivePack,
}
impl Service {
/// Render this instance as string recognized by the git transport layer.
pub fn as_str(&self) -> &'static str {
match self {
Service::ReceivePack => "git-receive-pack",
Service::UploadPack => "git-upload-pack",
}
}
}
mod traits {
use std::convert::Infallible;
/// An error which can tell whether it's worth retrying to maybe succeed next time.
pub trait IsSpuriousError: std::error::Error {
/// Return `true` if retrying might result in a different outcome due to IO working out differently.
fn is_spurious(&self) -> bool {
false
}
}
impl IsSpuriousError for Infallible {}
impl IsSpuriousError for std::io::Error {
fn is_spurious(&self) -> bool {
// TODO: also include the new special Kinds (currently unstable)
use std::io::ErrorKind::*;
match self.kind() {
Unsupported | WriteZero | InvalidInput | InvalidData | WouldBlock | AlreadyExists
| AddrNotAvailable | NotConnected | Other | PermissionDenied | NotFound => false,
Interrupted | UnexpectedEof | OutOfMemory | TimedOut | BrokenPipe | AddrInUse | ConnectionAborted
| ConnectionReset | ConnectionRefused => true,
_ => false,
}
}
}
}
pub use traits::IsSpuriousError;
///
pub mod client;
#[doc(inline)]
#[cfg(any(
feature = "blocking-client",
all(feature = "async-client", any(feature = "async-std"))
))]
pub use client::connect;
#[cfg(all(feature = "async-client", feature = "blocking-client"))]
compile_error!("Cannot set both 'blocking-client' and 'async-client' features as they are mutually exclusive");
|
