Blame view

3rdparty/boost_1_81_0/libs/url/README.md 6.18 KB
66d54af3   Hu Chunming   提交_GLIBCXX_USE_CX...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
  [![Boost.URL](https://raw.githubusercontent.com/vinniefalco/url/master/doc/images/repo-logo.png)](http://master.url.cpp.al/)
  
  Branch          | [`master`](https://github.com/boostorg/url/tree/master)                                                                                             | [`develop`](https://github.com/boostorg/url/tree/develop) |
  --------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------------------------- |
  Docs            | [![Documentation](https://img.shields.io/badge/docs-master-brightgreen.svg)](http://master.url.cpp.al/)                                             | [![Documentation](https://img.shields.io/badge/docs-develop-brightgreen.svg)](http://develop.url.cpp.al/)
  [Drone](https://drone.io/) | [![Build Status](https://drone.cpp.al/api/badges/boostorg/url/status.svg?ref=refs/heads/master)](https://drone.cpp.al/boostorg/url)                 | [![Build Status](https://drone.cpp.al/api/badges/boostorg/url/status.svg?ref=refs/heads/develop)](https://drone.cpp.al/boostorg/url)
  [GitHub Actions](https://github.com/) | [![CI](https://github.com/boostorg/url/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/boostorg/url/actions/workflows/ci.yml) | [![CI](https://github.com/boostorg/url/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/boostorg/url/actions/workflows/ci.yml)
  [codecov.io](https://codecov.io) | [![codecov](https://codecov.io/gh/boostorg/url/branch/master/graph/badge.svg)](https://codecov.io/gh/boostorg/url/branch/master)                    | [![codecov](https://codecov.io/gh/boostorg/url/branch/develop/graph/badge.svg)](https://codecov.io/gh/boostorg/url/branch/develop)
  Matrix          | [![Matrix](https://img.shields.io/badge/matrix-master-brightgreen.svg)](http://www.boost.org/development/tests/master/developer/url.html)           | [![Matrix](https://img.shields.io/badge/matrix-develop-brightgreen.svg)](http://www.boost.org/development/tests/develop/developer/url.html)
  
  # Boost.URL
  
  ## Overview
  
  Boost.URL is a portable C++ library which provides containers and algorithms
  which model a "URL", more formally described using the Uniform Resource
  Identifier (URI) specification (henceforth referred to as rfc3986). A URL
  is a compact sequence of characters that identifies an abstract or physical
  resource. For example, this is a valid URL which satisfies the
  absolute-URI grammar:
  
  ```
  https://www.example.com/path/to/file.txt?userid=1001&page=2&results=full
  ```
  
  This library understands the various grammars related to URLs and provides
  for validating and parsing of strings, manipulation of URL strings, and
  algorithms operating on URLs such as normalization and resolution. While
  the library is general purpose, special care has been taken to ensure that
  the implementation and data representation are friendly to network programs
  which need to handle URLs efficiently and securely, including the case where
  the inputs come from untrusted sources. Interfaces are provided for using
  error codes instead of exceptions as needed, and all algorithms provide a
  mechanism for avoiding memory allocations entirely if desired. Another
  feature of the library is that all container mutations leave the URL in
  a valid state. Code which uses Boost.URL will be easy to read, flexible,
  and performant.
  
  Network programs such as those using Boost.Asio or Boost.Beast often
  encounter the need to process, generate, or modify URLs. This library
  provides a very much needed modular component for handling these
  use-cases.
  
  ## Example
  ```cpp
  using namespace boost::urls;
  
  // Parse a URL. This allocates no memory. The view
  // references the character buffer without taking ownership.
  //
  url_view uv( "https://www.example.com/path/to/file.txt?id=1001&name=John%20Doe&results=full" );
  
  // Print the query parameters with percent-decoding applied
  //
  for( auto v : uv.params() )
      std::cout << v.key << "=" << v.value << " ";
  
  // Prints: id=1001 name=John Doe results=full
  
  // Create a modifiable copy of `uv`, with ownership of the buffer
  //
  url u = uv;
  
  // Change some elements in the URL
  //
  u.set_scheme( "http" )
   .set_encoded_host( "boost.org" )
   .set_encoded_path( "/index.htm" )
   .remove_query()
   .remove_fragment()
   .params().append( "key", "value" );
  
  std::cout << u;
  
  // Prints: http://boost.org/index.htm?key=value
  ```
  
  ## Design Goals
  
  The library achieves these goals:
  
  * Require only C++11
  * Works without exceptions
  * Fast compilation, no templates
  * Strict compliance with rfc3986
  * Allocate memory or use inline storage
  * Optional header-only, without linking to a library
  
  ## Requirements
  
  * Requires Boost and a compiler supporting at least C++11
  * Aliases for standard types use their Boost equivalents
  * Link to a built static or dynamic Boost library, or use header-only (see below)
  * Supports -fno-exceptions, detected automatically
  
  ### Header-Only
  
  To use as header-only; that is, to eliminate the requirement to
  link a program to a static or dynamic Boost.URL library, simply
  place the following line in exactly one new or existing source
  file in your project.
  ```cpp
  #include <boost/url/src.hpp>
  ```
  
  ### Embedded
  
  Boost.URL works great on embedded devices. It can be used in a way
  that avoids all dynamic memory allocations. Furthermore it is designed 
  to work without exceptions if desired.
  
  ### Supported Compilers
  
  Boost.URL is tested with the following compilers:
  
  * clang: 3.8, 4, 5, 6, 7, 8, 9, 10, 11, 12
  * gcc: 4.8, 4.9, 5, 6, 7, 8, 9, 10, 11
  * msvc: 14.0, 14.1, 14.2, 14.3
  
  and these architectures: x86, x64, ARM64, S390x
  
  ### Quality Assurance
  
  The development infrastructure for the library includes
  these per-commit analyses:
  
  * Coverage reports
  * Benchmark performance comparisons
  * Compilation and tests on Drone.io
  
  ## Visual Studio Solution Generation
  
      cmake -G "Visual Studio 16 2019" -A Win32 -B bin -DCMAKE_TOOLCHAIN_FILE=cmake/toolchains/msvc.cmake
      cmake -G "Visual Studio 16 2019" -A x64 -B bin64 -DCMAKE_TOOLCHAIN_FILE=cmake/toolchains/msvc.cmake
  
  ## License
  
  Distributed under the Boost Software License, Version 1.0.
  (See accompanying file [LICENSE_1_0.txt](LICENSE_1_0.txt) or copy at
  https://www.boost.org/LICENSE_1_0.txt)