Struct h2::proto::streams::streams::StreamRef

pub(crate) struct StreamRef<B> {
    opaque: OpaqueStreamRef,
    send_buffer: Arc<SendBuffer<B>>,
}

Reference to the stream state

Fields

opaque: OpaqueStreamRef

send_buffer: Arc<SendBuffer<B>>

Implementations

impl<B> StreamRef<B>

pub fn send_data(&mut self, data: B, end_stream: bool) -> Result<(), UserError>where B: Buf,

pub fn send_trailers(&mut self, trailers: HeaderMap) -> Result<(), UserError>

pub fn send_reset(&mut self, reason: Reason)

pub fn send_response( &mut self, response: Response<()>, end_of_stream: bool ) -> Result<(), UserError>

pub fn send_push_promise( &mut self, request: Request<()> ) -> Result<StreamRef<B>, UserError>

pub fn take_request(&self) -> Request<()>

Called by the server after the stream is accepted. Given that clients initialize streams by sending HEADERS, the request will always be available.

Panics

This function panics if the request isn’t present.

pub fn is_pending_open(&self) -> bool

Called by a client to see if the current stream is pending open

pub fn reserve_capacity(&mut self, capacity: u32)

Request capacity to send data

pub fn capacity(&self) -> u32

Returns the stream’s current send capacity.

pub fn poll_capacity( &mut self, cx: &Context<'_> ) -> Poll<Option<Result<u32, UserError>>>

Request to be notified when the stream’s capacity increases

pub(crate) fn poll_reset( &mut self, cx: &Context<'_>, mode: PollReset ) -> Poll<Result<Reason, Error>>

Request to be notified for if a RST_STREAM is received for this stream.

pub fn clone_to_opaque(&self) -> OpaqueStreamRef

pub fn stream_id(&self) -> StreamId

Trait Implementations

impl<B> Clone for StreamRef<B>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug> Debug for StreamRef<B>

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

Formats the value using the given formatter.