//! Declare the lowest level of stream: a stream that operates on raw

//! cells.

use crate::circuit::{sendme, StreamTarget};

use crate::{Error, Result};

use tor_cell::relaycell::msg::RelayMsg;

use crate::circuit::sendme::StreamRecvWindow;

use futures::channel::mpsc;

use futures::stream::StreamExt;

/// The read part of a stream on a particular circuit.

pub struct StreamReader {

    /// The underlying `StreamTarget` for this stream.

    pub(crate) target: StreamTarget,

    /// Channel to receive stream messages from the reactor.

    pub(crate) receiver: mpsc::Receiver<RelayMsg>,

    /// Congestion control receive window for this stream.

    ///

    /// Having this here means we're only going to update it when the end consumer of this stream

    /// actually reads things, meaning we don't ask for more data until it's actually needed (as

    /// opposed to having the reactor assume we're always reading, and potentially overwhelm itself

    /// with having to buffer data).

    pub(crate) recv_window: StreamRecvWindow,

    /// Whether or not this stream has ended.

    pub(crate) ended: bool,

}

impl StreamReader {

    /// Try to read the next relay message from this stream.

            // Prevent reading from streams after they've ended.

            // This probably means that the other side closed the

            // mpsc channel.  I'm not sure the error type is correct though?

    /// As recv_raw, but if there is an error or an end cell, note that this

    /// stream has ended.

        }

    /// Shut down this stream.

}