Documentation

Std.Http.Data.Method

Method #

This module provides the Method type that represents HTTP request methods. It defines all IANA-registered HTTP methods as distinct constructors, including standard methods (e.g. GET, POST, PUT, DELETE) and extension methods from WebDAV, CalDAV, and other specifications. Unrecognized method strings produce none from ofString?.

References:

source
inductive Std.Http.Method :
Type

A method is a verb that describes the action to be performed.

Covers all methods in the IANA HTTP Method Registry.

Instances For
    source
    @[instance_reducible]
    instance Std.Http.instReprMethod :
    Repr Method
    source
    def Std.Http.instReprMethod.repr :
    Method → Nat → Format
    Instances For
      source
      @[instance_reducible]
      instance Std.Http.instInhabitedMethod :
      Inhabited Method
      source
      @[instance_reducible]
      instance Std.Http.instBEqMethod :
      BEq Method
      source
      def Std.Http.instBEqMethod.beq :
      Method → Method → Bool
      Instances For
        source
        @[instance_reducible]
        instance Std.Http.instDecidableEqMethod :
        DecidableEq Method
        source
        def Std.Http.Method.ofString? :
        String → Option Method

        Converts a String into a Method. Returns none for unrecognized method strings.

        Instances For
          source
          def Std.Http.Method.ofString! (s : String) :
          Method

          Converts a String into a Method, panicking if unrecognized.

          Instances For
            source
            def Std.Http.Method.isIdempotent (m : Method) :
            Bool

            Returns true for HTTP methods that RFC 9110 §9.2.2 designates as idempotent — methods that can be safely retried because repeating the request has the same effect as issuing it once.

            Reference: https://httpwg.org/specs/rfc9110.html#idempotent.methods

            Instances For
              source
              def Std.Http.Method.isSafe (m : Method) :
              Bool

              Returns true for HTTP methods that RFC 9110 §9.2.1 designates as safe — read-only methods that do not modify resource state.

              Reference: https://httpwg.org/specs/rfc9110.html#safe.methods

              Instances For
                source
                @[instance_reducible]
                instance Std.Http.Method.instToString :
                ToString Method
                source
                @[instance_reducible]
                instance Std.Http.Method.instEncodeV11 :
                Internal.Encode Version.v11 Method