Struct gix_filter::driver::process::Server

pub struct Server { /* private fields */ }

A handle to facilitate typical server interactions that include the handshake and command-invocations.

Implementations

impl Server

pub fn handshake( stdin: Stdin, stdout: Stdout, welcome_prefix: &str, pick_version: &mut dyn FnMut(&[usize]) -> Option<usize>, available_capabilities: &[&str] ) -> Result<Self, Error>

Perform a handshake with the client sending information to our stdin and receiving information through our stdout in packetline format. pick_version is called with all versions supported by the client to pick one from, or None to indicate the handshake should stop. Use available_capabilities to match our capabilities with the ones from the client, so we communicate at most a subset of these.

Note

The server claims exclusive access over stdout and stdin, so all kinds of other output has to be steered towards stderr or there will be a deadlock.

pub fn next_request(&mut self) -> Result<Option<Request<'_>>, Error>

Read the next request and return it, even if command is not supported by us. If Ok(None) is reported, the request loop should end and the process should be shutdown gracefully.

The reason for allowing any command is that the caller would have to match on the command anyway, and would have to handle invalid commands that way.

Lifecycle

Note that the process is supposed to shut-down once there are no more requests, and git will wait until it has finished.

impl Server

Access

pub fn capabilities(&self) -> &HashSet<String>

Return the list of capabilities we are allowed to use, as negotiated with the client.

pub fn version(&self) -> usize

Return the negotiated version of the protocol.