use std::{ io, ops::{Deref, DerefMut}, }; use async_trait::async_trait; use futures_io::{AsyncBufRead, AsyncRead}; use crate::{ client::{Error, MessageKind}, Protocol, }; /// A function `f(is_error, text)` receiving progress or error information. /// As it is not a future itself, it must not block. If IO is performed within the function, be sure to spawn /// it onto an executor. pub type HandleProgress = Box; /// This trait exists to get a version of a `git_packetline::Provider` without type parameters. /// For the sake of usability, it also implements [`std::io::BufRead`] making it trivial to (eventually) /// read pack files while keeping the possibility to read individual lines with low overhead. #[async_trait(?Send)] pub trait ExtendedBufRead: AsyncBufRead { /// Set the handler to which progress will be delivered. /// /// Note that this is only possible if packet lines are sent in side band mode. fn set_progress_handler(&mut self, handle_progress: Option); /// Peek the next data packet line. Maybe None if the next line is a packet we stop at, queryable using /// [`stopped_at()`][ExtendedBufRead::stopped_at()]. async fn peek_data_line(&mut self) -> Option>>; /// Resets the reader to allow reading past a previous stop, and sets delimiters according to the /// given protocol. fn reset(&mut self, version: Protocol); /// Return the kind of message at which the reader stopped. fn stopped_at(&self) -> Option; } #[async_trait(?Send)] impl<'a, T: ExtendedBufRead + ?Sized + 'a + Unpin> ExtendedBufRead for Box { fn set_progress_handler(&mut self, handle_progress: Option) { self.deref_mut().set_progress_handler(handle_progress) } async fn peek_data_line(&mut self) -> Option>> { self.deref_mut().peek_data_line().await } fn reset(&mut self, version: Protocol) { self.deref_mut().reset(version) } fn stopped_at(&self) -> Option { self.deref().stopped_at() } } #[async_trait(?Send)] impl<'a, T: AsyncRead + Unpin> ExtendedBufRead for git_packetline::read::WithSidebands<'a, T, HandleProgress> { fn set_progress_handler(&mut self, handle_progress: Option) { self.set_progress_handler(handle_progress) } async fn peek_data_line(&mut self) -> Option>> { match self.peek_data_line().await { Some(Ok(Ok(line))) => Some(Ok(Ok(line))), Some(Ok(Err(err))) => Some(Ok(Err(err.into()))), Some(Err(err)) => Some(Err(err)), None => None, } } fn reset(&mut self, version: Protocol) { match version { Protocol::V1 => self.reset_with(&[git_packetline::PacketLine::Flush]), Protocol::V2 => { self.reset_with(&[git_packetline::PacketLine::Delimiter, git_packetline::PacketLine::Flush]) } } } fn stopped_at(&self) -> Option { self.stopped_at().map(|l| match l { git_packetline::PacketLine::Flush => MessageKind::Flush, git_packetline::PacketLine::Delimiter => MessageKind::Delimiter, git_packetline::PacketLine::ResponseEnd => MessageKind::ResponseEnd, git_packetline::PacketLine::Data(_) => unreachable!("data cannot be a delimiter"), }) } }