Struct proxy_header::io::ProxiedStream

pub struct ProxiedStream<IO> { /* private fields */ }

Wrapper around a stream that starts with a proxy header.

See module level documentation

Implementations

impl<IO> ProxiedStream<IO>

pub fn unproxied(io: IO) -> Self

Create a new proxied stream from an stream that does not have a proxy header.

This is useful if you want to use the same stream type for proxied and unproxied connections.

pub fn proxy_header(&self) -> &ProxyHeader<'_>

Get the proxy header.

pub fn get_ref(&self) -> &IO

Gets a reference to the underlying stream.

pub fn get_mut(&mut self) -> &mut IO

Gets a mutable reference to the underlying stream.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut IO>

Gets a pinned mutable reference to the underlying stream.

pub fn into_inner(self) -> IO

Consumes this wrapper, returning the underlying stream.

impl<IO> ProxiedStream<IO>

where IO: AsyncRead + Unpin,

pub async fn create_from_tokio(io: IO, config: ParseConfig) -> Result<Self>

Available on crate feature tokio only.

Reads the proxy header from an tokio::io::AsyncRead stream and returns a new ProxiedStream.

This method will read from the stream until a proxy header is found, or the stream is closed. If the stream is closed before a proxy header is found, this method will return an io::Error with io::ErrorKind::UnexpectedEof.

If the stream contains invalid data, this method will return an io::Error with io::ErrorKind::InvalidData. In case of an error, the stream is dropped, and any remaining bytes are discarded (which usually means the connection is closed).

impl<IO> ProxiedStream<IO>

where IO: Read,

pub fn create_from_std(io: IO, config: ParseConfig) -> Result<Self>

Reads the proxy header from a Read stream and returns a new ProxiedStream.

Other than the fact that this method is synchronous, it is identical to create_from_tokio.

Trait Implementations

impl<IO> AsFd for ProxiedStream<IO>

where IO: AsFd,

Available on Unix or WASI only.

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl<IO> AsRawFd for ProxiedStream<IO>

where IO: AsRawFd,

Available on Unix or WASI only.

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<IO> AsyncBufRead for ProxiedStream<IO>

where IO: AsyncBufRead,

Available on crate feature tokio only.

fn poll_fill_buf( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<&[u8]>>

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<IO> AsyncRead for ProxiedStream<IO>

where IO: AsyncRead,

Available on crate feature tokio only.

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl<IO> AsyncWrite for ProxiedStream<IO>

where IO: AsyncWrite,

Available on crate feature tokio only.

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<IO> BufRead for ProxiedStream<IO>

where IO: BufRead,

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

fn has_data_left(&mut self) -> Result<bool, Error>

🔬This is a nightly-only experimental API. (buf_read_has_data_left)

Check if the underlying Read has any data left to be read.

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

🔬This is a nightly-only experimental API. (bufread_skip_until)

Skip all bytes until the delimiter byte or EOF is reached.

fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<IO: Debug> Debug for ProxiedStream<IO>

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

Formats the value using the given formatter.

impl<IO> Read for ProxiedStream<IO>

where IO: Read,

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<IO> Write for ProxiedStream<IO>

where IO: Write,

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>

Writes a formatted string into this writer, returning any error encountered.

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.