Struct git_transport::client::git::Connection

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

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

Trait Implementations

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

pub fn handshake(
    &mut self,
    service: Service
) -> Result<SetServiceResponse<'_>, Error>

Initiate connection to the given service. Returns the service capabilities according according to the actual Protocol it supports, and possibly a list of refs to be obtained. This means that asking for an unsupported protocol will result in a protocol downgrade to the given one. using the read_line(…) function of the given BufReader. It must be exhausted, that is, read to the end, before the next method can be invoked.

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

Obtain a writer for sending data and obtaining the response. It can be configured in various ways, and should to support with the task at hand. send_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(). If handle_progress is not None, it's function passed a text line without trailing LF from which progress information can be parsed.

pub fn close(&mut self) -> Result<(), Error>

Closes the connection to indicate no further requests will be made.

pub 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.

pub fn desired_protocol_version(&self) -> Protocol

Returns the protocol version that was initially desired upon connection Please note that the actual protocol might differ after the handshake was conducted in case the server does not support it.

pub fn is_stateful(&self) -> bool

Returns true if the transport is inherently stateful, or false otherwise. Not being stateful implies that certain information has to be resent on each 'turn' of the fetch negotiation. This answer should not be based on the Protocol itself, which might enforce stateless interactions despite the connections staying intact.

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

If the handshake or subsequent reads failed with 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.