Enum git_packetline::PacketLineRef

pub enum PacketLineRef<'a> {
    Data(&'a [u8]),
    Flush,
    Delimiter,
    ResponseEnd,
}

A borrowed packet line as it refers to a slice of data by reference.

Variants

Data(&'a [u8])

A chunk of raw data.

Flush

A flush packet.

Delimiter

A delimiter packet.

ResponseEnd

The end of the response.

Implementations

impl<'a> PacketLineRef<'a>

pub fn write_to(&self, out: impl Write) -> Result<usize>

Serialize this instance to out in git packetline format, returning the amount of bytes written to out.

impl<'a> PacketLineRef<'a>

pub fn as_slice(&self) -> Option<&[u8]>

Return this instance as slice if it’s Data.

pub fn as_bstr(&self) -> Option<&BStr>

Return this instance’s as_slice() as BStr.

pub fn as_error(&self) -> Option<ErrorRef<'_>>

Interpret this instance’s as_slice() as ErrorRef.

This works for any data received in an error channel.

Note that this creates an unchecked error using the slice verbatim, which is useful to serialize it. See check_error() for a version that assures the error information is in the expected format.

pub fn check_error(&self) -> Option<ErrorRef<'_>>

Check this instance’s as_slice() is a valid ErrorRef and return it.

This works for any data received in an error channel.

pub fn as_text(&self) -> Option<TextRef<'_>>

Return this instance as text, with the trailing newline truncated if present.

pub fn as_band(&self, kind: Channel) -> Option<BandRef<'_>>

Interpret the data in this slice as BandRef according to the given kind of channel.

Note that this is only relevant in a side-band channel. See decode_band() in case kind is unknown.

pub fn decode_band(&self) -> Result<BandRef<'_>, Error>

Decode the band of this slice

Trait Implementations

impl<'a> Clone for PacketLineRef<'a>

fn clone(&self) -> PacketLineRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PacketLineRef<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for PacketLineRef<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for PacketLineRef<'a>

fn cmp(&self, other: &PacketLineRef<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'a> PartialEq<PacketLineRef<'a>> for PacketLineRef<'a>

fn eq(&self, other: &PacketLineRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PacketLineRef<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<PacketLineRef<'a>> for PacketLineRef<'a>

fn partial_cmp(&self, other: &PacketLineRef<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Copy for PacketLineRef<'a>

impl<'a> Eq for PacketLineRef<'a>

impl<'a> StructuralEq for PacketLineRef<'a>

impl<'a> StructuralPartialEq for PacketLineRef<'a>