Struct gix_transport::client::Capabilities

pub struct Capabilities { /* private fields */ }

A structure to represent multiple capabilities or features supported by the server.

Deviation

As a shortcoming, we are unable to parse V1 as emitted from git-upload-pack without a git-daemon or server, as it will not emit any capabilities for some reason. Only V2 and V0 work in that context.

Implementations

impl Capabilities

pub fn from_lines_with_version_detection<T: Read>( rd: &mut StreamingPeekableIter<T> ) -> Result<Outcome<'_>, Error>

Available on crate feature blocking-client only.

Read the capabilities and version advertisement from the given packetline reader.

If Protocol::V1 was requested, or the remote decided to downgrade, the remote refs advertisement will also be included in the Outcome.

impl Capabilities

pub fn from_bytes(bytes: &[u8]) -> Result<(Capabilities, usize), Error>

Parse capabilities from the given bytes.

Useful in case they are encoded within a ref behind a null byte.

pub fn from_lines(lines_buf: BString) -> Result<Capabilities, Error>

Parse capabilities from the given a lines_buf which is expected to be all newline separated lines from the server.

Useful for parsing capabilities from a data sent from a server, and to avoid having to deal with blocking and async traits for as long as possible. There is no value in parsing a few bytes in a non-blocking fashion.

pub fn contains(&self, feature: &str) -> bool

Returns true of the given feature is mentioned in this list of capabilities.

pub fn capability(&self, name: &str) -> Option<Capability<'_>>

Returns the capability with name.

pub fn iter(&self) -> impl Iterator<Item = Capability<'_>>

Returns an iterator over all capabilities.

Trait Implementations

impl Clone for Capabilities

fn clone(&self) -> Capabilities

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Capabilities

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

Formats the value using the given formatter.

impl Default for Capabilities

This implementation yields exactly those minimal capabilities that are required for gix to work, nothing more and nothing less.

This is a bit of a hack just get tests with Protocol V0 to work, which is a good way to enforce stateful transports. Of course, V1 would also do that but when calling git-upload-pack directly, it advertises so badly that this is easier to implement.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Capabilities

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Capabilities

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.