Struct Response

pub struct Response { /* private fields */ }

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

A representation of a complete fetch response

Implementations

impl Response

pub fn from_line_reader<'a>( version: Protocol, reader: &mut impl ExtendedBufRead<'a>, client_expects_pack: bool, wants_to_negotiate: bool, ) -> Result<Response, Error>

Available on crate feature blocking-client only.

Parse a response of the given version of the protocol from reader.

client_expects_pack is only relevant for V1 stateful connections, and if false, causes us to stop parsing when seeing NAK, and if true we will keep parsing until we get a pack as the client already signalled to the server that it’s done. This way of doing things allows us to exploit knowledge about more recent versions of the protocol, which keeps code easier and more localized without having to support all the cruft that there is.

wants_to_negotiate should be false for clones which is when we don’t have sent any haves. The reason for this flag to exist is to predict how to parse V1 output only, and neither client_expects_pack nor wants_to_negotiate are relevant for V2. This ugliness is in place to avoid having to resort to an an even more complex ugliness that git has to use to predict how many acks are supposed to be read. We also genuinely hope that this covers it all….

impl Response

pub fn has_pack(&self) -> bool

Return true if the response has a pack which can be read next.

pub fn check_required_features( version: Protocol, features: &[Feature], ) -> Result<(), Error>

Return an error if the given features don’t contain the required ones (the ones this implementation needs) for the given version of the protocol.

Even though technically any set of features supported by the server could work, we only implement the ones that make it easy to maintain all versions with a single code base that aims to be and remain maintainable.

pub fn acknowledgements(&self) -> &[Acknowledgement]

Return all acknowledgements parsed previously.

pub fn shallow_updates(&self) -> &[ShallowUpdate]

Return all shallow update lines parsed previously.

pub fn append_v1_shallow_updates(&mut self, updates: Option<Vec<ShallowUpdate>>)

Append the given updates which may have been obtained from a (handshake::Outcome)crate::handshake::Outcome::v1_shallow_updates.

In V2, these are received as part of the pack, but V1 sends them early, so we offer to re-integrate them here.

pub fn wanted_refs(&self) -> &[WantedRef]

Return all wanted-refs parsed previously.

Trait Implementations

impl Debug for Response

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.