Enum Method 

#[non_exhaustive]
pub enum Method {
    Get,
    Put,
    Post,
    Delete,
    Options,
    Head,
    Patch,
    Trace,
    Query,
}

An HTTP method that has a dedicated Path Item field. #[non_exhaustive] because OpenAPI 3.2 adds to this and the addition is #[cfg]-gated. Cargo unifies features across a dependency graph, so any crate enabling openapi32 enables it for every crate in the build – and without this attribute that would turn a downstream exhaustive match into a compile error, which is not what “purely additive” is supposed to mean.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Get

GET.

Put

PUT.

Post

POST.

Delete

DELETE.

Options

OPTIONS.

Head

HEAD.

Patch

PATCH.

Trace

TRACE.

Query

QUERY, as defined by the HTTP QUERY method draft.

Introduced in OpenAPI 3.2.

Implementations

impl Method

pub fn all() -> &'static [Self]

Every method with a dedicated Path Item field.

pub fn as_wire_str(self) -> &'static str

The method name as it appears on the wire.

pub fn from_wire_str(name: &str) -> Option<Self>

The method with this wire spelling, if it has a Path Item field.

Case-sensitive: HTTP method tokens are, and a description that spelled one differently would not be describing the same request. Returns None for a method OpenAPI has no field for, which is a different answer from “not a method” — under openapi32 those reach a Path Item through additionalOperations instead.

Trait Implementations

impl Clone for Method

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Method

impl Debug for Method

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Method

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Method

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

Formats the value using the given formatter.

impl Eq for Method

impl From<Method> for Method

Available on crate feature http only.

A described method has a wire spelling, so this direction never fails.

The pair exists because kynos exposes both this type and http::Method in adjacent APIs — an Observer receives a request’s method and a route’s — and could not write the conversion itself: both types are foreign to it, so the orphan rule puts these here.

fn from(method: Method) -> Self

Converts to this type from the input type.

impl Hash for Method

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Method

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Method

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Method

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Method

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Method

impl TryFrom<&Method> for Method

Available on crate feature http only.

Not every HTTP method is one a Path Item has a field for.

Fallible on purpose, and in two ways worth telling apart in a message rather than in the type: an extension method has no variant at all, and QUERY has one only under openapi32. Both reach a Path Item through additionalOperations, which is 3.2’s answer and not a conversion.

type Error = UnnamedMethod

The type returned in the event of a conversion error.

fn try_from(method: &Method) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Method> for Method

Available on crate feature http only.

type Error = UnnamedMethod

The type returned in the event of a conversion error.

fn try_from(method: Method) -> Result<Self, Self::Error>

Performs the conversion.