Stdlib/std.net.http

std.net.http

Types

type Cookie = Cookie

struct CookieError

type CookieJar = CookieJar

struct CookieKey

struct CookieKeyError

type Headers = Headers

struct HttpRequest

struct HttpResponse

struct InvalidUriError

enum Method

type PrivateCookieJar = PrivateCookieJar

enum SameSite

type StatusCode = int

struct Uri

Global Variables

pub const Accepted: StatusCode

The request has been received but not yet acted upon. It is noncommittal, since there is no way in HTTP to later send an asynchronous response indicating the outcome of the request. It is intended for cases where another process or server handles the request, or for batch processing.

pub const AlreadyReportedWebDAV: StatusCode

Used inside a dav:propstat response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection.

pub const BadGateway: StatusCode

This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.

pub const BadRequest: StatusCode

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

pub const Conflict: StatusCode

This response is sent when a request conflicts with the current state of the server.

pub const Continue: StatusCode

This interim response indicates that the client should continue the request or ignore the response if the request is already finished.

pub const Created: StatusCode

The request succeeded, and a new resource was created as a result. This is typically the response sent after POST requests, or some PUT requests.

pub const EarlyHints: StatusCode

This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response or preconnect to an origin from which the page will need resources.

pub const ExpectationFailed: StatusCode

This response code means the expectation indicated by the Expect request header field cannot be met by the server.

pub const FailedDependencyWebDAV: StatusCode

The request failed due to failure of a previous request.

pub const Forbidden: StatusCode

pub const Unauthorized, the client's identity is known to the server.:StatusCode = The client does not have access rights to the content as StatusCode; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 as StatusCode;

pub const Found: StatusCode

This response code means that the URI of requested resource has been changed temporarily. Further changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests.

pub const GatewayTimeout: StatusCode

This error response is given when the server is acting as a gateway and cannot get a response in time.

pub const Gone: StatusCode

This response is sent when the requested content has been permanently deleted from server, with no forwarding address. Clients are expected to remove their caches and links to the resource. The HTTP specification intends this status code to be used for "limited-time, promotional services". APIs should not feel compelled to indicate resources that have been deleted with this status code.

pub const HTTPVersionNotSupported: StatusCode

The HTTP version used in the request is not supported by the server.

pub const IMUsedHTTPDeltaEncoding: StatusCode

The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.

pub const ImATeapot: StatusCode

The server refuses the attempt to brew coffee with a teapot.

pub const InsufficientStorageWebDAV: StatusCode

The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.

pub const InternalServerError: StatusCode

The server has encountered a situation it does not know how to handle.

pub const LengthRequired: StatusCode

Server rejected the request because the Content-Length header field is not defined and the server requires it.

pub const LockedWebDAV: StatusCode

The resource that is being accessed is locked.

pub const LoopDetectedWebDAV: StatusCode

The server detected an infinite loop while processing the request.

pub const MethodNotAllowed: StatusCode

The request method is known by the server but is not supported by the target resource. For example, an API may not allow calling DELETE to remove a resource.

pub const MisdirectedRequest: StatusCode

The request was directed at a server that is not able to produce a response. This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI.

pub const MovedPermanently: StatusCode

The URL of the requested resource has been changed permanently. The new URL is given in the response.

pub const MultiStatusWebDAV: StatusCode

Conveys information about multiple resources, for situations where multiple status codes might be appropriate.

pub const MultipleChoices: StatusCode

The request has more than one possible response. The user agent or user should choose one of them. (There is no standardized way of choosing one of the responses, but HTML links to the possibilities are recommended so the user can pick.)

pub const NetworkAuthenticationRequired: StatusCode

Indicates that the client needs to authenticate to gain network access.

pub const NoContent: StatusCode

There is no content to send for this request, but the headers may be useful. The user agent may update its cached headers for this resource with the new ones.

pub const NonAuthoritativeInformation: StatusCode

pub const OK response is preferred to this status.:StatusCode = This response code means the returned metadata is not exactly the same as is available from the origin server, but is collected from a local or a third-party copy. This is mostly used for mirrors or backups of another resource. Except for that specific case, the 200 as StatusCode;

pub const NotAcceptable: StatusCode

This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content that conforms to the criteria given by the user agent.

pub const NotExtended: StatusCode

Further extensions to the request are required for the server to fulfill it.

pub const NotFound: StatusCode

pub const Forbidden to hide the existence of a resource from an unauthorized client. This response code is probably the most well known due to its frequent occurrence on the web.:StatusCode = The server cannot find the requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 as StatusCode;

pub const NotImplemented: StatusCode

The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD.

pub const NotModified: StatusCode

This is used for caching purposes. It tells the client that the response has not been modified, so the client can continue to use the same cached version of the response.

pub const OK: StatusCode

The request succeeded. The result meaning of "success" depends on the HTTP method: GET: The resource has been fetched and transmitted in the message body. HEAD: The representation headers are included in the response without any message body. PUT or POST: The resource describing the result of the action is transmitted in the message body. TRACE: The message body contains the request message as received by the server.

pub const PartialContent: StatusCode

This response code is used when the Range header is sent from the client to request only part of a resource.

pub const PayloadTooLarge: StatusCode

Request entity is larger than limits defined by server. The server might close the connection or return an Retry-After header field.

pub const PaymentRequiredExperimental: StatusCode

This response code is reserved for future use. The initial aim for creating this code was using it for digital payment systems, however this status code is used very rarely and no standard convention exists.

pub const PermanentRedirect: StatusCode

pub const Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.:StatusCode = This means that the resource is now permanently located at another URI, specified by the Location: HTTP Response header. This has the same semantics as the 301 as StatusCode;

pub const PreconditionFailed: StatusCode

The client has indicated preconditions in its headers which the server does not meet.

pub const PreconditionRequired: StatusCode

The origin server requires the request to be conditional. This response is intended to prevent the 'lost update' problem, where a client GETs a resource's state, modifies it and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict.

pub const ProcessingWebDAV: StatusCode

This code indicates that the server has received and is processing the request, but no response is available yet.

pub const ProxyAuthenticationRequired: StatusCode

pub const Unauthorized but authentication is needed to be done by a proxy.:StatusCode = This is similar to 401 as StatusCode;

pub const RangeNotSatisfiable: StatusCode

The range specified by the Range header field in the request cannot be fulfilled. It's possible that the range is outside the size of the target URI's data.

pub const RequestHeaderFieldsTooLarge: StatusCode

The server is unwilling to process the request because its header fields are too large. The request may be resubmitted after reducing the size of the request header fields.

pub const RequestTimeout: StatusCode

This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection. This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that some servers merely shut down the connection without sending this message.

pub const ResetContent: StatusCode

Tells the user agent to reset the document which sent this request.

pub const SeeOther: StatusCode

The server sent this response to direct the client to get the requested resource at another URI with a GET request.

pub const ServiceUnavailable: StatusCode

The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This response should be used for temporary conditions and the Retry-After HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.

pub const SwitchingProtocols: StatusCode

This code is sent in response to an Upgrade request header from the client and indicates the protocol the server is switching to.

pub const TemporaryRedirect: StatusCode

pub const Found HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.:StatusCode = The server sends this response to direct the client to get the requested resource at another URI with the same method that was used in the prior request. This has the same semantics as the 302 as StatusCode;

pub const TooEarlyExperimental: StatusCode

Indicates that the server is unwilling to risk processing a request that might be replayed.

pub const TooManyRequests: StatusCode

The user has sent too many requests in a given amount of time ("rate limiting").

pub const URITooLong: StatusCode

The URI requested by the client is longer than the server is willing to interpret.

pub const Unauthorized: StatusCode

Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.

pub const UnavailableForLegalReasons: StatusCode

The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.

pub const UnprocessableContentWebDAV: StatusCode

The request was well-formed but was unable to be followed due to semantic errors.

pub const UnsupportedMediaType: StatusCode

The media format of the requested data is not supported by the server, so the server is rejecting the request.

pub const Unused: StatusCode

This response code is no longer used as StatusCode; it is just reserved. It was used in a previous version of the HTTP/1.1 specification.

pub const UpgradeRequired: StatusCode

pub const response to indicate the required protocol(s).:StatusCode = The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. The server sends an Upgrade header in a 426 as StatusCode;

pub const UseProxyDeprecated: StatusCode

Defined in a previous version of the HTTP specification to indicate that a requested response must be accessed by a proxy. It has been deprecated due to security concerns regarding in-band configuration of a proxy.

pub const VariantAlsoNegotiates: StatusCode

The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.

Functions

pub fn path_escape(s: string): string

Escapes the path part of a URI.

This function is useful for escaping the path part of a URI. It will escape all characters that are not allowed in a path.

pub fn path_unescape(s: string): string

Unescapes the path part of a URI.

This function is useful for unescaping the path part of a URI. It will unescape all percent-encoded characters in the path.

pub fn query_escape(s: string): string

Escapes the query part of a URI.

This function is useful for escaping the query part of a URI. It will escape all characters that are not allowed in a query.

pub fn query_unescape(s: string): string

Unescapes the query part of a URI.

This function is useful for unescaping the query part of a URI. It will unescape all percent-encoded characters in the query.