status

Documentation

Overview

Package status provides status codes for gemini protocols.

Index

• func Text(code Code) string
• type Code
  • func (code Code) Int() int
  • func (i Code) String() string

Functions

func Text

func Text(code Code) string

Text returns a code text representation in "iteger_code text_description" format.

Types

type Code

type Code int

Code is a gemini protocol status code. Reference document: gemini://gemini.circumlunar.space/docs/specification.gmi

const (
	// Undefined is a default empty status code value.
	Undefined Code = 0 // <UNDEFINED STATUS CODE>

	// Input means that the requested resource accepts a line of textual user input.  The <META> line is a prompt which
	// should be displayed to the user.  The same resource should then be requested again with the user's
	// input included as a query component.  Queries are included in requests as per the usual generic URL
	// definition in RFC3986, i.e. separated from the path by a ?.  Reserved characters used in the user's
	// input must be "percent-encoded" as per RFC3986, and space characters should also be percent-encoded.
	Input Code = 10 // INPUT

	// InputSensitive as per status code 10, but for use with sensitive input such as
	// passwords. Clients should present the prompt as per status code 10, but
	// the user's input should not be echoed to the screen to prevent it being
	// read by "shoulder surfers".
	InputSensitive Code = 11 // SENSITIVE INPUT

	// Success means that the request was handled successfully and a response body will follow the
	// response header.  The <META> line is a MIME media type which applies to
	// the response body.
	Success Code = 20 // SUCCESS

	// Redirect means that the server is redirecting the client to a new
	// location for the requested resource.  There is no response body.  <META>
	// is a new URL for the requested resource.  The URL may be absolute or
	// relative.  The redirect should be considered temporary, i.e. clients
	// should continue to request the resource at the original address and
	// should not performance convenience actions like automatically updating
	// bookmarks.  There is no response body.
	Redirect Code = 30 // REDIRECT - TEMPORARY

	// RedirectPermanent means that the requested resource should be consistently requested
	// from the new URL provided in future. Tools like search engine indexers or
	// content aggregators should update their configurations to avoid
	// requesting the old URL, and end-user clients may automatically update
	// bookmarks, etc. Note that clients which only pay attention to the initial
	// digit of status codes will treat this as a temporary redirect. They will
	// still end up at the right place, they just won't be able to make use of
	// the knowledge that this redirect is permanent, so they'll pay a small
	// performance penalty by having to follow the redirect each time.
	RedirectPermanent Code = 31 // REDIRECT - PERMANENT

	// TemporaryFailure means that The request has failed.  There is no response
	// body.  The nature of the failure is temporary, i.e. an identical request
	// MAY succeed in the future.  The contents of <META> may provide additional
	// information on the failure, and should be displayed to human users.
	TemporaryFailure Code = 40 // TEMPORARY FAILURE

	// ServerUnavailable means that the server is unavailable due to overload or maintenance. (cf HTTP 503)
	ServerUnavailable Code = 41 // SERVER UNAVAILABLE

	// CGIError means that a CGI process, or similar system for generating
	// dynamic content, died unexpectedly or timed out.
	CGIError Code = 42 // CGI ERROR

	// ProxyError means that a proxy request failed because the server was
	// unable to successfully complete a transaction with the remote host.
	// (cf HTTP 502, 504)
	ProxyError Code = 43 // PROXY ERROR

	// SlowDown means that rate limiting is in effect. <META> is an integer
	// number of seconds which the client must wait before another request is
	// made to this server. (cf HTTP 429)
	SlowDown Code = 44 // SLOW DOWN

	// PermanentFailure means that the request has failed.  There is no response
	// body.  The nature of the failure is permanent, i.e. identical future
	// requests will reliably fail for the same reason.  The contents of <META>
	// may provide additional information on the failure, and should be
	// displayed to human users.  Automatic clients such as aggregators or
	// indexing crawlers should not repeat this request.
	PermanentFailure Code = 50 // PERMANENT FAILURE

	// NotFound means that the requested resource could not be found but may
	// be available in the future. (cf HTTP 404) (struggling to remember this
	// important status code? Easy: you can't find things hidden at Area 51!)
	NotFound Code = 51 // NOT FOUND

	// Gone means that the resource requested is no longer available and will not be available
	// again. Search engines and similar tools should remove this resource from
	// their indices. Content aggregators should stop requesting the resource
	// and convey to their human users that the subscribed resource is gone.
	// (cf HTTP 410)
	Gone Code = 52 // GONE

	// ProxyRequestRefused means that the request was for a resource at a domain
	// not served by the server and the server does not accept proxy requests.
	ProxyRequestRefused Code = 53 // PROXY REQUEST REFUSED

	// BadRequest means that server was unable to parse the client's request,
	// presumably due to a malformed request. (cf HTTP 400)
	BadRequest Code = 59 // BAD REQUEST

	// ClientCertificateRequired means that the requested resource requires a
	// client certificate to access.  If the request was made without a
	// certificate, it should be repeated with one.  If the request was made
	// with a certificate, the server did not accept it and the request should
	// be repeated with a different certificate.  The contents of <META> (and/or
	// the specific 6x code) may provide additional information on certificate
	// requirements or the reason a certificate was rejected.
	ClientCertificateRequired Code = 60 // CLIENT CERTIFICATE REQUIRED

	// CertificateNotAuthorized means that supplied client certificate is not
	// authorized for accessing the particular requested resource. The problem
	// is not with the certificate itself, which may be authoriszed for other
	// resources.
	CertificateNotAuthorized Code = 61 // CERTIFICATE NOT AUTHORIZED

	// ClientCertificateNotValid means that supplied client certificate was not
	// accepted because it is not valid. This indicates a problem with the
	// certificate in and of itself, with no consideration of the particular
	// requested resource. The most likely cause is that the certificate's
	// validity start date is in the future or its expiry date has passed, but
	// this code may also indicate an invalid signature, or a violation of a
	// X509 standard requirements. The <META> should provide more information
	// about the exact error.
	ClientCertificateNotValid Code = 62 // CERTIFICATE NOT VALID
)

Comments copy-pasted from official gemini specification.

func (Code) Int

func (code Code) Int() int

Int retursn an integer code representation.

func (Code) String

func (i Code) String() string