enum
   HTTP::Status
 
  Overview
An enum that provides additional support around HTTP status codes.
Based on Hypertext Transfer Protocol (HTTP) Status Code Registry
It provides constants for the defined HTTP status codes as well as helper methods to easily identify the type of response.
NOTE  To use Status, you must explicitly import it with require "http/status"
Defined in:
http/status.crEnum Members
- 
        CONTINUE = 100
- 
        SWITCHING_PROTOCOLS = 101
- 
        PROCESSING = 102
- 
        EARLY_HINTS = 103
- 
        OK = 200
- 
        CREATED = 201
- 
        ACCEPTED = 202
- 
        NON_AUTHORITATIVE_INFORMATION = 203
- 
        NO_CONTENT = 204
- 
        RESET_CONTENT = 205
- 
        PARTIAL_CONTENT = 206
- 
        MULTI_STATUS = 207
- 
        ALREADY_REPORTED = 208
- 
        IM_USED = 226
- 
        MULTIPLE_CHOICES = 300
- 
        MOVED_PERMANENTLY = 301
- 
        FOUND = 302
- 
        SEE_OTHER = 303
- 
        NOT_MODIFIED = 304
- 
        USE_PROXY = 305
- 
        SWITCH_PROXY = 306
- 
        TEMPORARY_REDIRECT = 307
- 
        PERMANENT_REDIRECT = 308
- 
        BAD_REQUEST = 400
- 
        UNAUTHORIZED = 401
- 
        PAYMENT_REQUIRED = 402
- 
        FORBIDDEN = 403
- 
        NOT_FOUND = 404
- 
        METHOD_NOT_ALLOWED = 405
- 
        NOT_ACCEPTABLE = 406
- 
        PROXY_AUTHENTICATION_REQUIRED = 407
- 
        REQUEST_TIMEOUT = 408
- 
        CONFLICT = 409
- 
        GONE = 410
- 
        LENGTH_REQUIRED = 411
- 
        PRECONDITION_FAILED = 412
- 
        PAYLOAD_TOO_LARGE = 413
- 
        URI_TOO_LONG = 414
- 
        UNSUPPORTED_MEDIA_TYPE = 415
- 
        RANGE_NOT_SATISFIABLE = 416
- 
        EXPECTATION_FAILED = 417
- 
        IM_A_TEAPOT = 418
- 
        MISDIRECTED_REQUEST = 421
- 
        UNPROCESSABLE_ENTITY = 422
- 
        LOCKED = 423
- 
        FAILED_DEPENDENCY = 424
- 
        UPGRADE_REQUIRED = 426
- 
        PRECONDITION_REQUIRED = 428
- 
        TOO_MANY_REQUESTS = 429
- 
        REQUEST_HEADER_FIELDS_TOO_LARGE = 431
- 
        UNAVAILABLE_FOR_LEGAL_REASONS = 451
- 
        INTERNAL_SERVER_ERROR = 500
- 
        NOT_IMPLEMENTED = 501
- 
        BAD_GATEWAY = 502
- 
        SERVICE_UNAVAILABLE = 503
- 
        GATEWAY_TIMEOUT = 504
- 
        HTTP_VERSION_NOT_SUPPORTED = 505
- 
        VARIANT_ALSO_NEGOTIATES = 506
- 
        INSUFFICIENT_STORAGE = 507
- 
        LOOP_DETECTED = 508
- 
        NOT_EXTENDED = 510
- 
        NETWORK_AUTHENTICATION_REQUIRED = 511
Constructors
- 
        .new(status_code : Int32)
        
          Create a new status instance with the given status code, or raise an error if the status code given is not inside 100..999. 
Instance Method Summary
- 
        #accepted?
        
          Returns trueif this enum value equalsACCEPTED
- 
        #already_reported?
        
          Returns trueif this enum value equalsALREADY_REPORTED
- 
        #bad_gateway?
        
          Returns trueif this enum value equalsBAD_GATEWAY
- 
        #bad_request?
        
          Returns trueif this enum value equalsBAD_REQUEST
- 
        #client_error? : Bool
        
          Returns trueif the response status code is between 400 and 499.
- 
        #code : Int32
        
          Returns the number that represents the HTTP status code. 
- 
        #conflict?
        
          Returns trueif this enum value equalsCONFLICT
- 
        #continue?
        
          Returns trueif this enum value equalsCONTINUE
- 
        #created?
        
          Returns trueif this enum value equalsCREATED
- 
        #description : String | Nil
        
          Returns the default status description of the given HTTP status code. 
- 
        #early_hints?
        
          Returns trueif this enum value equalsEARLY_HINTS
- 
        #expectation_failed?
        
          Returns trueif this enum value equalsEXPECTATION_FAILED
- 
        #failed_dependency?
        
          Returns trueif this enum value equalsFAILED_DEPENDENCY
- 
        #forbidden?
        
          Returns trueif this enum value equalsFORBIDDEN
- 
        #found?
        
          Returns trueif this enum value equalsFOUND
- 
        #gateway_timeout?
        
          Returns trueif this enum value equalsGATEWAY_TIMEOUT
- 
        #gone?
        
          Returns trueif this enum value equalsGONE
- 
        #http_version_not_supported?
        
          Returns trueif this enum value equalsHTTP_VERSION_NOT_SUPPORTED
- 
        #im_a_teapot?
        
          Returns trueif this enum value equalsIM_A_TEAPOT
- 
        #im_used?
        
          Returns trueif this enum value equalsIM_USED
- 
        #informational? : Bool
        
          Returns trueif the response status code is between 100 and 199.
- 
        #insufficient_storage?
        
          Returns trueif this enum value equalsINSUFFICIENT_STORAGE
- 
        #internal_server_error?
        
          Returns trueif this enum value equalsINTERNAL_SERVER_ERROR
- 
        #length_required?
        
          Returns trueif this enum value equalsLENGTH_REQUIRED
- 
        #locked?
        
          Returns trueif this enum value equalsLOCKED
- 
        #loop_detected?
        
          Returns trueif this enum value equalsLOOP_DETECTED
- 
        #method_not_allowed?
        
          Returns trueif this enum value equalsMETHOD_NOT_ALLOWED
- 
        #misdirected_request?
        
          Returns trueif this enum value equalsMISDIRECTED_REQUEST
- 
        #moved_permanently?
        
          Returns trueif this enum value equalsMOVED_PERMANENTLY
- 
        #multi_status?
        
          Returns trueif this enum value equalsMULTI_STATUS
- 
        #multiple_choices?
        
          Returns trueif this enum value equalsMULTIPLE_CHOICES
- 
        #network_authentication_required?
        
          Returns trueif this enum value equalsNETWORK_AUTHENTICATION_REQUIRED
- 
        #no_content?
        
          Returns trueif this enum value equalsNO_CONTENT
- 
        #non_authoritative_information?
        
          Returns trueif this enum value equalsNON_AUTHORITATIVE_INFORMATION
- 
        #not_acceptable?
        
          Returns trueif this enum value equalsNOT_ACCEPTABLE
- 
        #not_extended?
        
          Returns trueif this enum value equalsNOT_EXTENDED
- 
        #not_found?
        
          Returns trueif this enum value equalsNOT_FOUND
- 
        #not_implemented?
        
          Returns trueif this enum value equalsNOT_IMPLEMENTED
- 
        #not_modified?
        
          Returns trueif this enum value equalsNOT_MODIFIED
- 
        #ok?
        
          Returns trueif this enum value equalsOK
- 
        #partial_content?
        
          Returns trueif this enum value equalsPARTIAL_CONTENT
- 
        #payload_too_large?
        
          Returns trueif this enum value equalsPAYLOAD_TOO_LARGE
- 
        #payment_required?
        
          Returns trueif this enum value equalsPAYMENT_REQUIRED
- 
        #permanent_redirect?
        
          Returns trueif this enum value equalsPERMANENT_REDIRECT
- 
        #precondition_failed?
        
          Returns trueif this enum value equalsPRECONDITION_FAILED
- 
        #precondition_required?
        
          Returns trueif this enum value equalsPRECONDITION_REQUIRED
- 
        #processing?
        
          Returns trueif this enum value equalsPROCESSING
- 
        #proxy_authentication_required?
        
          Returns trueif this enum value equalsPROXY_AUTHENTICATION_REQUIRED
- 
        #range_not_satisfiable?
        
          Returns trueif this enum value equalsRANGE_NOT_SATISFIABLE
- 
        #redirection? : Bool
        
          Returns trueif the response status code is between 300 and 399.
- 
        #request_header_fields_too_large?
        
          Returns trueif this enum value equalsREQUEST_HEADER_FIELDS_TOO_LARGE
- 
        #request_timeout?
        
          Returns trueif this enum value equalsREQUEST_TIMEOUT
- 
        #reset_content?
        
          Returns trueif this enum value equalsRESET_CONTENT
- 
        #see_other?
        
          Returns trueif this enum value equalsSEE_OTHER
- 
        #server_error? : Bool
        
          Returns trueif the response status code is between 500 and 599.
- 
        #service_unavailable?
        
          Returns trueif this enum value equalsSERVICE_UNAVAILABLE
- 
        #success? : Bool
        
          Returns trueif the response status code is between 200 and 299.
- 
        #switch_proxy?
        
          Returns trueif this enum value equalsSWITCH_PROXY
- 
        #switching_protocols?
        
          Returns trueif this enum value equalsSWITCHING_PROTOCOLS
- 
        #temporary_redirect?
        
          Returns trueif this enum value equalsTEMPORARY_REDIRECT
- 
        #too_many_requests?
        
          Returns trueif this enum value equalsTOO_MANY_REQUESTS
- 
        #unauthorized?
        
          Returns trueif this enum value equalsUNAUTHORIZED
- 
        #unavailable_for_legal_reasons?
        
          Returns trueif this enum value equalsUNAVAILABLE_FOR_LEGAL_REASONS
- 
        #unprocessable_entity?
        
          Returns trueif this enum value equalsUNPROCESSABLE_ENTITY
- 
        #unsupported_media_type?
        
          Returns trueif this enum value equalsUNSUPPORTED_MEDIA_TYPE
- 
        #upgrade_required?
        
          Returns trueif this enum value equalsUPGRADE_REQUIRED
- 
        #uri_too_long?
        
          Returns trueif this enum value equalsURI_TOO_LONG
- 
        #use_proxy?
        
          Returns trueif this enum value equalsUSE_PROXY
- 
        #variant_also_negotiates?
        
          Returns trueif this enum value equalsVARIANT_ALSO_NEGOTIATES
Instance methods inherited from struct Enum
  
  
    
      &(other : self) : self
    &, 
    
  
    
      +(other : Int) : self
    +, 
    
  
    
      -(other : Int) : self
    -, 
    
  
    
      <=>(other : self)
    <=>, 
    
  
    
      ==(other : self)==(other) ==, ^(other : self) : self ^, |(other : self) : self |, ~ : self ~, clone clone, each(& : self -> ) each, hash(hasher) hash, includes?(other : self) : Bool includes?, inspect(io : IO) : Nil inspect, to_f32 : Float32 to_f32, to_f32! : Float32 to_f32!, to_f64 : Float64 to_f64, to_f64! : Float64 to_f64!, to_i : Int32 to_i, to_i128 : Int128 to_i128, to_i128! : Int128 to_i128!, to_i16 : Int16 to_i16, to_i16! : Int16 to_i16!, to_i32 : Int32 to_i32, to_i32! : Int32 to_i32!, to_i64 : Int64 to_i64, to_i64! : Int64 to_i64!, to_i8 : Int8 to_i8, to_i8! : Int8 to_i8!, to_json(json : JSON::Builder) to_json, to_s(io : IO) : Nil
to_s : String to_s, to_u128 : UInt128 to_u128, to_u128! : UInt128 to_u128!, to_u16 : UInt16 to_u16, to_u16! : UInt16 to_u16!, to_u32 : UInt32 to_u32, to_u32! : UInt32 to_u32!, to_u64 : UInt64 to_u64, to_u64! : UInt64 to_u64!, to_u8 : UInt8 to_u8, to_u8! : UInt8 to_u8!, to_yaml(yaml : YAML::Nodes::Builder) to_yaml, value : Int value
Constructor methods inherited from struct Enum
  
  
    
      from_value(value : Int) : self
    from_value, 
    
  
    
      new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)new(value : self)
new(pull : JSON::PullParser) new, parse(string : String) : self parse
Class methods inherited from struct Enum
  
  
    
      each(& : self -> )
    each, 
    
  
    
      from_value?(value : Int) : self | Nil
    from_value?, 
    
  
    
      names : Array(String)
    names, 
    
  
    
      parse?(string : String) : self | Nil
    parse?, 
    
  
    
      valid?(value : self) : Bool
    valid?, 
    
  
    
      values : Array(self)
    values
    
  
      
  Macros inherited from struct Enum
  
  
    
      [](*values)
    [], 
    
  
    
      flags(*values)
    flags
    
  
    
      
  Instance methods inherited from module Comparable(Enum)
  
  
    
      <(other : T) : Bool
    <, 
    
  
    
      <=(other : T)
    <=, 
    
  
    
      <=>(other : T)
    <=>, 
    
  
    
      ==(other : T)
    ==, 
    
  
    
      >(other : T) : Bool
    >, 
    
  
    
      >=(other : T)
    >=, 
    
  
    
      clamp(min, max)clamp(range : Range) clamp
Instance methods inherited from struct Value
  
  
    
      ==(other : JSON::Any)==(other : YAML::Any)
==(other) ==, dup dup
Instance methods inherited from class Object
  
  
    
      ! : Bool
    !, 
    
  
    
      !=(other)
    !=, 
    
  
    
      !~(other)
    !~, 
    
  
    
      ==(other)
    ==, 
    
  
    
      ===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message)
not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as
Class methods inherited from class Object
  
  
    
      from_json(string_or_io, root : String)from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml
Macros inherited from class Object
  
  
    
      class_getter(*names, &block)
    class_getter, 
    
  
    
      class_getter!(*names)
    class_getter!, 
    
  
    
      class_getter?(*names, &block)
    class_getter?, 
    
  
    
      class_property(*names, &block)
    class_property, 
    
  
    
      class_property!(*names)
    class_property!, 
    
  
    
      class_property?(*names, &block)
    class_property?, 
    
  
    
      class_setter(*names)
    class_setter, 
    
  
    
      def_clone
    def_clone, 
    
  
    
      def_equals(*fields)
    def_equals, 
    
  
    
      def_equals_and_hash(*fields)
    def_equals_and_hash, 
    
  
    
      def_hash(*fields)
    def_hash, 
    
  
    
      delegate(*methods, to object)
    delegate, 
    
  
    
      forward_missing_to(delegate)
    forward_missing_to, 
    
  
    
      getter(*names, &block)
    getter, 
    
  
    
      getter!(*names)
    getter!, 
    
  
    
      getter?(*names, &block)
    getter?, 
    
  
    
      property(*names, &block)
    property, 
    
  
    
      property!(*names)
    property!, 
    
  
    
      property?(*names, &block)
    property?, 
    
  
    
      setter(*names)
    setter
    
  
    
  Constructor Detail
Create a new status instance with the given status code, or raise an error if the status code given is not inside 100..999.
require "http/status"
HTTP::Status.new(100)  # => HTTP::Status::CONTINUE
HTTP::Status.new(202)  # => HTTP::Status::ACCEPTED
HTTP::Status.new(123)  # => 123
HTTP::Status.new(1000) # raises ArgumentErrorInstance Method Detail
Returns true if the response status code is between 400 and 499.
require "http/status"
HTTP::Status::METHOD_NOT_ALLOWED.client_error?    # => true
HTTP::Status::INTERNAL_SERVER_ERROR.client_error? # => falseReturns the number that represents the HTTP status code.
require "http/status"
status = HTTP::Status::NO_CONTENT
status.code # => 204Returns the default status description of the given HTTP status code.
require "http/status"
HTTP::Status.new(123).description               # => nil
HTTP::Status::NO_CONTENT.description            # => "No Content"
HTTP::Status::METHOD_NOT_ALLOWED.description    # => "Method Not Allowed"
HTTP::Status::INTERNAL_SERVER_ERROR.description # => "Internal Server Error"Returns true if the response status code is between 100 and 199.
require "http/status"
HTTP::Status::SWITCHING_PROTOCOLS.informational?   # => true
HTTP::Status::INTERNAL_SERVER_ERROR.informational? # => falseReturns true if this enum value equals NETWORK_AUTHENTICATION_REQUIRED
Returns true if this enum value equals NON_AUTHORITATIVE_INFORMATION
Returns true if this enum value equals PROXY_AUTHENTICATION_REQUIRED
Returns true if the response status code is between 300 and 399.
require "http/status"
HTTP::Status::SWITCH_PROXY.redirection?          # => true
HTTP::Status::INTERNAL_SERVER_ERROR.redirection? # => falseReturns true if this enum value equals REQUEST_HEADER_FIELDS_TOO_LARGE
Returns true if the response status code is between 500 and 599.
require "http/status"
HTTP::Status::INTERNAL_SERVER_ERROR.server_error? # => true
HTTP::Status::METHOD_NOT_ALLOWED.server_error?    # => falseReturns true if the response status code is between 200 and 299.
require "http/status"
HTTP::Status::NO_CONTENT.success?            # => true
HTTP::Status::INTERNAL_SERVER_ERROR.success? # => false