gix_protocol/
lib.rs

1//! An abstraction over [fetching][fetch()] a pack from the server.
2//!
3//! Generally, there is the following order of operations.
4//!
5//! * create a `Transport`, either blocking or async
6//! * perform a [`handshake()`]
7//! * execute a [`Command`]
8//!     - [list references](LsRefsCommand)
9//!          - create a mapping between [refspecs and references](fetch::RefMap)
10//!     - [receive a pack](fetch())
11//!
12//! ## Feature Flags
13#![cfg_attr(
14    all(doc, feature = "document-features"),
15    doc = ::document_features::document_features!()
16)]
17#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg))]
18#![deny(missing_docs, unsafe_code)]
19
20/// A function that performs a given credential action, trying to obtain credentials for an operation that needs it.
21///
22/// Useful for both `fetch` and `push`.
23#[cfg(feature = "handshake")]
24pub type AuthenticateFn<'a> = Box<dyn FnMut(gix_credentials::helper::Action) -> gix_credentials::protocol::Result + 'a>;
25
26/// A selector for V2 commands to invoke on the server for purpose of pre-invocation validation.
27#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
28pub enum Command {
29    /// List references.
30    LsRefs,
31    /// Fetch a pack.
32    Fetch,
33}
34pub mod command;
35
36#[cfg(all(feature = "async-client", not(feature = "blocking-client")))]
37pub use ::bisync::asynchronous as bisync;
38#[cfg(feature = "blocking-client")]
39pub use ::bisync::synchronous as bisync;
40#[cfg(feature = "async-client")]
41pub use async_trait;
42#[cfg(feature = "async-client")]
43pub use futures_io;
44#[cfg(feature = "async-client")]
45pub use futures_lite;
46#[cfg(feature = "handshake")]
47pub use gix_credentials as credentials;
48/// A convenience export allowing users of gix-protocol to use the transport layer without their own cargo dependency.
49pub use gix_transport as transport;
50
51///
52pub mod fetch;
53#[cfg(any(feature = "blocking-client", feature = "async-client"))]
54pub use fetch::function::fetch;
55
56mod remote_progress;
57pub use remote_progress::RemoteProgress;
58
59///
60pub mod handshake;
61#[cfg(any(feature = "blocking-client", feature = "async-client"))]
62#[cfg(feature = "handshake")]
63pub use handshake::function::handshake;
64#[cfg(feature = "handshake")]
65pub use handshake::hero::Handshake;
66
67///
68pub mod ls_refs;
69#[cfg(any(feature = "blocking-client", feature = "async-client"))]
70pub use ls_refs::function::LsRefsCommand;
71
72mod util;
73pub use util::*;
gix_protocol/lib.rs

gix_protocol/
lib.rs
