Enum gemini::status::Code

pub enum Code {
    Input,
    SensitiveInput,
    Success,
    TemporaryRedirect,
    PermanentRedirect,
    TemporaryFailure,
    ServerUnavailable,
    CGIError,
    ProxyError,
    SlowDown,
    PermanentFailure,
    NotFound,
    Gone,
    ProxyRequestRefused,
    BadRequest,
    ClientCertificateRequired,
    ClientCertificateNotAuthorised,
    CertificateNotValid,
}

The precise two digit numeric code associated with a Status.

Status codes not present in the spec are considered errors.

Variants

Input

The requested resource accepts a line of textual user input. The 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.

SensitiveInput

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”.

Success

The request was handled successfully and a response body will follow the response header. The line is a MIME media type which applies to the response body.

TemporaryRedirect

The server is redirecting the client to a new location for the requested resource. There is no response body. 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.

PermanentRedirect

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.

TemporaryFailure

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 may provide additional information on the failure, and should be displayed to human users.

ServerUnavailable

The server is unavailable due to overload or maintenance. (cf HTTP 503)

CGIError

A CGI process, or similar system for generating dynamic content, died unexpectedly or timed out.

ProxyError

A proxy request failed because the server was unable to successfully complete a transaction with the remote host. (cf HTTP 502, 504)

SlowDown

Rate limiting is in effect. is an integer number of seconds which the client must wait before another request is made to this server. (cf HTTP 429)

PermanentFailure

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 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.

NotFound

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!)

Gone

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)

ProxyRequestRefused

The request was for a resource at a domain not served by the server and the server does not accept proxy requests.

BadRequest

The server was unable to parse the client’s request, presumably due to a malformed request. (cf HTTP 400)

ClientCertificateRequired

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 (and/or the specific 6x code) may provide additional information on certificate requirements or the reason a certificate was rejected.

ClientCertificateNotAuthorised

The supplied client certificate is not authorised for accessing the particular requested resource. The problem is not with the certificate itself, which may be authorised for other resources.

CertificateNotValid

The 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 should provide more information about the exact error.

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Code

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

Formats the value using the given formatter.

impl Ord for Code

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Code> for Code

fn eq(&self, other: &Code) -> 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 !=.

impl PartialOrd<Code> for Code

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Code

impl Eq for Code

impl StructuralEq for Code

impl StructuralPartialEq for Code