Struct h2::Reason

pub struct Reason(_);

HTTP/2 error codes.

Error codes are used in RST_STREAM and GOAWAY frames to convey the reasons for the stream or connection error. For example, SendStream::send_reset takes a Reason argument. Also, the Error type may contain a Reason.

Error codes share a common code space. Some error codes apply only to streams, others apply only to connections, and others may apply to either. See [RFC 7540] for more information.

See Error Codes in the spec.

Implementations

impl Reason

pub const NO_ERROR: Reason = _

The associated condition is not a result of an error.

For example, a GOAWAY might include this code to indicate graceful shutdown of a connection.

pub const PROTOCOL_ERROR: Reason = _

The endpoint detected an unspecific protocol error.

This error is for use when a more specific error code is not available.

pub const INTERNAL_ERROR: Reason = _

The endpoint encountered an unexpected internal error.

pub const FLOW_CONTROL_ERROR: Reason = _

The endpoint detected that its peer violated the flow-control protocol.

pub const SETTINGS_TIMEOUT: Reason = _

The endpoint sent a SETTINGS frame but did not receive a response in a timely manner.

pub const STREAM_CLOSED: Reason = _

The endpoint received a frame after a stream was half-closed.

pub const FRAME_SIZE_ERROR: Reason = _

The endpoint received a frame with an invalid size.

pub const REFUSED_STREAM: Reason = _

The endpoint refused the stream prior to performing any application processing.

pub const CANCEL: Reason = _

Used by the endpoint to indicate that the stream is no longer needed.

pub const COMPRESSION_ERROR: Reason = _

The endpoint is unable to maintain the header compression context for the connection.

pub const CONNECT_ERROR: Reason = _

The connection established in response to a CONNECT request was reset or abnormally closed.

pub const ENHANCE_YOUR_CALM: Reason = _

The endpoint detected that its peer is exhibiting a behavior that might be generating excessive load.

pub const INADEQUATE_SECURITY: Reason = _

The underlying transport has properties that do not meet minimum security requirements.

pub const HTTP_1_1_REQUIRED: Reason = _

The endpoint requires that HTTP/1.1 be used instead of HTTP/2.

pub fn description(&self) -> &str

Get a string description of the error code.

Trait Implementations

impl Clone for Reason

fn clone(&self) -> Reason

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Reason

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

Formats the value using the given formatter.

impl Display for Reason

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

Formats the value using the given formatter.

impl From<Reason> for Error

fn from(src: Reason) -> Error

Converts to this type from the input type.

impl From<Reason> for u32

fn from(src: Reason) -> u32

Converts to this type from the input type.

impl From<u32> for Reason

fn from(src: u32) -> Reason

Converts to this type from the input type.

impl PartialEq<Reason> for Reason

fn eq(&self, other: &Reason) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Reason

impl Eq for Reason

impl StructuralEq for Reason

impl StructuralPartialEq for Reason