beast/http/field.hpp

0001 //
0002 // Copyright (c) 2016-2019 Vinnie Falco (vinnie dot falco at gmail dot com)
0003 //
0004 // Distributed under the Boost Software License, Version 1.0. (See accompanying
0005 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
0006 //
0007 // Official repository: https://github.com/boostorg/beast
0008 //
0009
0010 #ifndef BOOST_BEAST_HTTP_FIELD_HPP
0011 #define BOOST_BEAST_HTTP_FIELD_HPP
0012
0013 #include <boost/beast/core/detail/config.hpp>
0014 #include <boost/beast/core/string.hpp>
0015 #include <iosfwd>
0016
0017 namespace boost {
0018 namespace beast {
0019 namespace http {
0020
0021     enum class field : unsigned short
0022     {
0023         unknown = 0,
0024
0025         a_im,
0026         accept,
0027         accept_additions,
0028         accept_charset,
0029         accept_datetime,
0030         accept_encoding,
0031         accept_features,
0032         accept_language,
0033         accept_patch,
0034         accept_post,
0035         accept_ranges,
0036         access_control,
0037         access_control_allow_credentials,
0038         access_control_allow_headers,
0039         access_control_allow_methods,
0040         access_control_allow_origin,
0041         access_control_expose_headers,
0042         access_control_max_age,
0043         access_control_request_headers,
0044         access_control_request_method,
0045         age,
0046         allow,
0047         alpn,
0048         also_control,
0049         alt_svc,
0050         alt_used,
0051         alternate_recipient,
0052         alternates,
0053         apparently_to,
0054         apply_to_redirect_ref,
0055         approved,
0056         archive,
0057         archived_at,
0058         article_names,
0059         article_updates,
0060         authentication_control,
0061         authentication_info,
0062         authentication_results,
0063         authorization,
0064         auto_submitted,
0065         autoforwarded,
0066         autosubmitted,
0067         base,
0068         bcc,
0069         body,
0070         c_ext,
0071         c_man,
0072         c_opt,
0073         c_pep,
0074         c_pep_info,
0075         cache_control,
0076         caldav_timezones,
0077         cancel_key,
0078         cancel_lock,
0079         cc,
0080         close,
0081         comments,
0082         compliance,
0083         connection,
0084         content_alternative,
0085         content_base,
0086         content_description,
0087         content_disposition,
0088         content_duration,
0089         content_encoding,
0090         content_features,
0091         content_id,
0092         content_identifier,
0093         content_language,
0094         content_length,
0095         content_location,
0096         content_md5,
0097         content_range,
0098         content_return,
0099         content_script_type,
0100         content_style_type,
0101         content_transfer_encoding,
0102         content_type,
0103         content_version,
0104         control,
0105         conversion,
0106         conversion_with_loss,
0107         cookie,
0108         cookie2,
0109         cost,
0110         dasl,
0111         date,
0112         date_received,
0113         dav,
0114         default_style,
0115         deferred_delivery,
0116         delivery_date,
0117         delta_base,
0118         depth,
0119         derived_from,
0120         destination,
0121         differential_id,
0122         digest,
0123         discarded_x400_ipms_extensions,
0124         discarded_x400_mts_extensions,
0125         disclose_recipients,
0126         disposition_notification_options,
0127         disposition_notification_to,
0128         distribution,
0129         dkim_signature,
0130         dl_expansion_history,
0131         downgraded_bcc,
0132         downgraded_cc,
0133         downgraded_disposition_notification_to,
0134         downgraded_final_recipient,
0135         downgraded_from,
0136         downgraded_in_reply_to,
0137         downgraded_mail_from,
0138         downgraded_message_id,
0139         downgraded_original_recipient,
0140         downgraded_rcpt_to,
0141         downgraded_references,
0142         downgraded_reply_to,
0143         downgraded_resent_bcc,
0144         downgraded_resent_cc,
0145         downgraded_resent_from,
0146         downgraded_resent_reply_to,
0147         downgraded_resent_sender,
0148         downgraded_resent_to,
0149         downgraded_return_path,
0150         downgraded_sender,
0151         downgraded_to,
0152         ediint_features,
0153         eesst_version,
0154         encoding,
0155         encrypted,
0156         errors_to,
0157         etag,
0158         expect,
0159         expires,
0160         expiry_date,
0161         ext,
0162         followup_to,
0163         forwarded,
0164         from,
0165         generate_delivery_report,
0166         getprofile,
0167         hobareg,
0168         host,
0169         http2_settings,
0170         if_,
0171         if_match,
0172         if_modified_since,
0173         if_none_match,
0174         if_range,
0175         if_schedule_tag_match,
0176         if_unmodified_since,
0177         im,
0178         importance,
0179         in_reply_to,
0180         incomplete_copy,
0181         injection_date,
0182         injection_info,
0183         jabber_id,
0184         keep_alive,
0185         keywords,
0186         label,
0187         language,
0188         last_modified,
0189         latest_delivery_time,
0190         lines,
0191         link,
0192         list_archive,
0193         list_help,
0194         list_id,
0195         list_owner,
0196         list_post,
0197         list_subscribe,
0198         list_unsubscribe,
0199         list_unsubscribe_post,
0200         location,
0201         lock_token,
0202         man,
0203         max_forwards,
0204         memento_datetime,
0205         message_context,
0206         message_id,
0207         message_type,
0208         meter,
0209         method_check,
0210         method_check_expires,
0211         mime_version,
0212         mmhs_acp127_message_identifier,
0213         mmhs_authorizing_users,
0214         mmhs_codress_message_indicator,
0215         mmhs_copy_precedence,
0216         mmhs_exempted_address,
0217         mmhs_extended_authorisation_info,
0218         mmhs_handling_instructions,
0219         mmhs_message_instructions,
0220         mmhs_message_type,
0221         mmhs_originator_plad,
0222         mmhs_originator_reference,
0223         mmhs_other_recipients_indicator_cc,
0224         mmhs_other_recipients_indicator_to,
0225         mmhs_primary_precedence,
0226         mmhs_subject_indicator_codes,
0227         mt_priority,
0228         negotiate,
0229         newsgroups,
0230         nntp_posting_date,
0231         nntp_posting_host,
0232         non_compliance,
0233         obsoletes,
0234         opt,
0235         optional,
0236         optional_www_authenticate,
0237         ordering_type,
0238         organization,
0239         origin,
0240         original_encoded_information_types,
0241         original_from,
0242         original_message_id,
0243         original_recipient,
0244         original_sender,
0245         original_subject,
0246         originator_return_address,
0247         overwrite,
0248         p3p,
0249         path,
0250         pep,
0251         pep_info,
0252         pics_label,
0253         position,
0254         posting_version,
0255         pragma,
0256         prefer,
0257         preference_applied,
0258         prevent_nondelivery_report,
0259         priority,
0260         privicon,
0261         profileobject,
0262         protocol,
0263         protocol_info,
0264         protocol_query,
0265         protocol_request,
0266         proxy_authenticate,
0267         proxy_authentication_info,
0268         proxy_authorization,
0269         proxy_connection,
0270         proxy_features,
0271         proxy_instruction,
0272         public_,
0273         public_key_pins,
0274         public_key_pins_report_only,
0275         range,
0276         received,
0277         received_spf,
0278         redirect_ref,
0279         references,
0280         referer,
0281         referer_root,
0282         relay_version,
0283         reply_by,
0284         reply_to,
0285         require_recipient_valid_since,
0286         resent_bcc,
0287         resent_cc,
0288         resent_date,
0289         resent_from,
0290         resent_message_id,
0291         resent_reply_to,
0292         resent_sender,
0293         resent_to,
0294         resolution_hint,
0295         resolver_location,
0296         retry_after,
0297         return_path,
0298         safe,
0299         schedule_reply,
0300         schedule_tag,
0301         sec_fetch_dest,
0302         sec_fetch_mode,
0303         sec_fetch_site,
0304         sec_fetch_user,
0305         sec_websocket_accept,
0306         sec_websocket_extensions,
0307         sec_websocket_key,
0308         sec_websocket_protocol,
0309         sec_websocket_version,
0310         security_scheme,
0311         see_also,
0312         sender,
0313         sensitivity,
0314         server,
0315         set_cookie,
0316         set_cookie2,
0317         setprofile,
0318         sio_label,
0319         sio_label_history,
0320         slug,
0321         soapaction,
0322         solicitation,
0323         status_uri,
0324         strict_transport_security,
0325         subject,
0326         subok,
0327         subst,
0328         summary,
0329         supersedes,
0330         surrogate_capability,
0331         surrogate_control,
0332         tcn,
0333         te,
0334         timeout,
0335         title,
0336         to,
0337         topic,
0338         trailer,
0339         transfer_encoding,
0340         ttl,
0341         ua_color,
0342         ua_media,
0343         ua_pixels,
0344         ua_resolution,
0345         ua_windowpixels,
0346         upgrade,
0347         urgency,
0348         uri,
0349         user_agent,
0350         variant_vary,
0351         vary,
0352         vbr_info,
0353         version,
0354         via,
0355         want_digest,
0356         warning,
0357         www_authenticate,
0358         x_archived_at,
0359         x_device_accept,
0360         x_device_accept_charset,
0361         x_device_accept_encoding,
0362         x_device_accept_language,
0363         x_device_user_agent,
0364         x_frame_options,
0365         x_mittente,
0366         x_pgp_sig,
0367         x_ricevuta,
0368         x_riferimento_message_id,
0369         x_tiporicevuta,
0370         x_trasporto,
0371         x_verificasicurezza,
0372         x400_content_identifier,
0373         x400_content_return,
0374         x400_content_type,
0375         x400_mts_identifier,
0376         x400_originator,
0377         x400_received,
0378         x400_recipients,
0379         x400_trace,
0380         xref
0381     };
0382 /** Convert a field enum to a string.
0383
0384     @param f The field to convert
0385 */
0386 BOOST_BEAST_DECL
0387 string_view
0388 to_string(field f);
0389
0390 /** Attempt to convert a string to a field enum.
0391
0392     The string comparison is case-insensitive.
0393
0394     @return The corresponding field, or @ref field::unknown
0395     if no known field matches.
0396 */
0397 BOOST_BEAST_DECL
0398 field
0399 string_to_field(string_view s);
0400
0401 /// Write the text for a field name to an output stream.
0402 BOOST_BEAST_DECL
0403 std::ostream&
0404 operator<<(std::ostream& os, field f);
0405
0406 } // http
0407 } // beast
0408 } // boost
0409
0410 #ifdef BOOST_BEAST_HEADER_ONLY
0411 #include <boost/beast/http/impl/field.ipp>
0412 #endif
0413
0414 #endif