Struct git_transport::client::git::Connection

pub struct Connection<R, W> { /* private fields */ }

Available on crate features blocking-client or async-client only.

A TCP connection to either a git daemon or a spawned git process.

When connecting to a daemon, additional context information is sent with the first line of the handshake. Otherwise that context is passed using command line arguments to a spawned git process.

Implementations

impl<R, W> Connection<R, W>where
    R: Read,
    W: Write,

pub fn new(
    read: R,
    write: W,
    desired_version: Protocol,
    repository_path: impl Into<BString>,
    virtual_host: Option<(impl Into<String>, Option<u16>)>,
    mode: ConnectMode
) -> Self

Available on crate feature blocking-client only.

Create a connection from the given read and write, asking for desired_version as preferred protocol and the transfer of the repository at repository_path.

virtual_host along with a port to which to connect to, while mode determines the kind of endpoint to connect to.

impl<R, W> Connection<R, W>

pub fn into_inner(self) -> (R, W)

Return the inner reader and writer

pub fn custom_url(self, url: Option<String>) -> Self

Optionally set the URL to be returned when asked for it if Some or calculate a default for None.

The URL is required as parameter for authentication helpers which are called in transports that support authentication. Even though plain git transports don’t support that, this may well be the case in custom transports.

Trait Implementations

impl<R, W> Transport for Connection<R, W>where
    R: Read,
    W: Write,

Available on crate feature blocking-client only.

fn handshake<'a>(
    &mut self,
    service: Service,
    extra_parameters: &'a [(&'a str, Option<&'a str>)]
) -> Result<SetServiceResponse<'_>, Error>

Initiate connection to the given service and send the given extra_parameters along with it.

impl<R, W> TransportWithoutIO for Connection<R, W>where
    R: Read,
    W: Write,

Available on crate feature blocking-client only.

fn supported_protocol_versions(&self) -> &[Protocol]

We implement this in a paranoid and safe way, not allowing downgrade to V1 which could send large amounts of refs in case we didn’t want to support V1.

fn request(
    &mut self,
    write_mode: WriteMode,
    on_into_read: MessageKind
) -> Result<RequestWriter<'_>, Error>

Get a writer for sending data and obtaining the response. It can be configured in various ways to support the task at hand. write_mode determines how calls to the write(…) method are interpreted, and on_into_read determines which message to write when the writer is turned into the response reader using into_read().

fn to_url(&self) -> String

Returns the canonical URL pointing to the destination of this transport. Please note that local paths may not be represented correctly, as they will go through a potentially lossy unicode conversion.

fn connection_persists_across_multiple_requests(&self) -> bool

Returns true if the transport provides persistent connections across multiple requests, or false otherwise. Not being persistent implies that certain information has to be resent on each ‘turn’ of the fetch negotiation or that the end of interaction (i.e. no further request will be made) has to be indicated to the server for most graceful termination of the connection.

fn configure(
    &mut self,
    _config: &dyn Any
) -> Result<(), Box<dyn Error + Send + Sync + 'static>>

Pass config can be cast and interpreted by the implementation, as documented separately.

fn set_identity(&mut self, _identity: Account) -> Result<(), Error>

If the handshake or subsequent reads failed with std::io::ErrorKind::PermissionDenied, use this method to inform the transport layer about the identity to use for subsequent calls. If authentication continues to fail even with an identity set, consider communicating this to the provider of the identity in order to mark it as invalid. Otherwise the user might have difficulty updating obsolete credentials. Please note that most transport layers are unauthenticated and thus return an error here.