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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, translate::*, Bytes, Error, UriFlags, UriHideFlags};

crate::wrapper! {
    /// The `GUri` type and related functions can be used to parse URIs into
    /// their components, and build valid URIs from individual components.
    ///
    /// Since `GUri` only represents absolute URIs, all `GUri`s will have a
    /// URI scheme, so [`scheme()`][Self::scheme()] will always return a non-`NULL`
    /// answer. Likewise, by definition, all URIs have a path component, so
    /// [`path()`][Self::path()] will always return a non-`NULL` string (which may
    /// be empty).
    ///
    /// If the URI string has an
    /// [‘authority’ component](https://tools.ietf.org/html/rfc3986#section-3) (that
    /// is, if the scheme is followed by `://` rather than just `:`), then the
    /// `GUri` will contain a hostname, and possibly a port and ‘userinfo’.
    /// Additionally, depending on how the `GUri` was constructed/parsed (for example,
    /// using the `G_URI_FLAGS_HAS_PASSWORD` and `G_URI_FLAGS_HAS_AUTH_PARAMS` flags),
    /// the userinfo may be split out into a username, password, and
    /// additional authorization-related parameters.
    ///
    /// Normally, the components of a `GUri` will have all `%`-encoded
    /// characters decoded. However, if you construct/parse a `GUri` with
    /// `G_URI_FLAGS_ENCODED`, then the `%`-encoding will be preserved instead in
    /// the userinfo, path, and query fields (and in the host field if also
    /// created with `G_URI_FLAGS_NON_DNS`). In particular, this is necessary if
    /// the URI may contain binary data or non-UTF-8 text, or if decoding
    /// the components might change the interpretation of the URI.
    ///
    /// For example, with the encoded flag:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue", G_URI_FLAGS_ENCODED, &err);
    /// g_assert_cmpstr (g_uri_get_query (uri), ==, "query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue");
    /// ```
    ///
    /// While the default `%`-decoding behaviour would give:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue", G_URI_FLAGS_NONE, &err);
    /// g_assert_cmpstr (g_uri_get_query (uri), ==, "query=http://host/path?param=value");
    /// ```
    ///
    /// During decoding, if an invalid UTF-8 string is encountered, parsing will fail
    /// with an error indicating the bad string location:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fbad%3D%00alue", G_URI_FLAGS_NONE, &err);
    /// g_assert_error (err, G_URI_ERROR, G_URI_ERROR_BAD_QUERY);
    /// ```
    ///
    /// You should pass `G_URI_FLAGS_ENCODED` or `G_URI_FLAGS_ENCODED_QUERY` if you
    /// need to handle that case manually. In particular, if the query string
    /// contains `=` characters that are `%`-encoded, you should let
    /// `GLib::Uri::parse_params()` do the decoding once of the query.
    ///
    /// `GUri` is immutable once constructed, and can safely be accessed from
    /// multiple threads. Its reference counting is atomic.
    ///
    /// Note that the scope of `GUri` is to help manipulate URIs in various applications,
    /// following [RFC 3986](https://tools.ietf.org/html/rfc3986). In particular,
    /// it doesn't intend to cover web browser needs, and doesn’t implement the
    /// [WHATWG URL](https://url.spec.whatwg.org/) standard. No APIs are provided to
    /// help prevent
    /// [homograph attacks](https://en.wikipedia.org/wiki/IDN_homograph_attack), so
    /// `GUri` is not suitable for formatting URIs for display to the user for making
    /// security-sensitive decisions.
    ///
    /// ## Relative and absolute URIs
    ///
    /// As defined in [RFC 3986](https://tools.ietf.org/html/rfc3986#section-4), the
    /// hierarchical nature of URIs means that they can either be ‘relative
    /// references’ (sometimes referred to as ‘relative URIs’) or ‘URIs’ (for
    /// clarity, ‘URIs’ are referred to in this documentation as
    /// ‘absolute URIs’ — although
    /// [in contrast to RFC 3986](https://tools.ietf.org/html/rfc3986#section-4.3),
    /// fragment identifiers are always allowed).
    ///
    /// Relative references have one or more components of the URI missing. In
    /// particular, they have no scheme. Any other component, such as hostname,
    /// query, etc. may be missing, apart from a path, which has to be specified (but
    /// may be empty). The path may be relative, starting with `./` rather than `/`.
    ///
    /// For example, a valid relative reference is `./path?query`,
    /// `/?query#fragment` or `//example.com`.
    ///
    /// Absolute URIs have a scheme specified. Any other components of the URI which
    /// are missing are specified as explicitly unset in the URI, rather than being
    /// resolved relative to a base URI using [`parse_relative()`][Self::parse_relative()].
    ///
    /// For example, a valid absolute URI is `file:///home/bob` or
    /// `https://search.com?query=string`.
    ///
    /// A `GUri` instance is always an absolute URI. A string may be an absolute URI
    /// or a relative reference; see the documentation for individual functions as to
    /// what forms they accept.
    ///
    /// ## Parsing URIs
    ///
    /// The most minimalist APIs for parsing URIs are [`split()`][Self::split()] and
    /// [`split_with_user()`][Self::split_with_user()]. These split a URI into its component
    /// parts, and return the parts; the difference between the two is that
    /// [`split()`][Self::split()] treats the ‘userinfo’ component of the URI as a
    /// single element, while [`split_with_user()`][Self::split_with_user()] can (depending on the
    /// [`UriFlags`][crate::UriFlags] you pass) treat it as containing a username, password,
    /// and authentication parameters. Alternatively, [`split_network()`][Self::split_network()]
    /// can be used when you are only interested in the components that are
    /// needed to initiate a network connection to the service (scheme,
    /// host, and port).
    ///
    /// [`parse()`][Self::parse()] is similar to [`split()`][Self::split()], but instead of
    /// returning individual strings, it returns a `GUri` structure (and it requires
    /// that the URI be an absolute URI).
    ///
    /// [`resolve_relative()`][Self::resolve_relative()] and [`parse_relative()`][Self::parse_relative()] allow
    /// you to resolve a relative URI relative to a base URI.
    /// [`resolve_relative()`][Self::resolve_relative()] takes two strings and returns a string,
    /// and [`parse_relative()`][Self::parse_relative()] takes a `GUri` and a string and returns a
    /// `GUri`.
    ///
    /// All of the parsing functions take a [`UriFlags`][crate::UriFlags] argument describing
    /// exactly how to parse the URI; see the documentation for that type
    /// for more details on the specific flags that you can pass. If you
    /// need to choose different flags based on the type of URI, you can
    /// use [`peek_scheme()`][Self::peek_scheme()] on the URI string to check the scheme
    /// first, and use that to decide what flags to parse it with.
    ///
    /// For example, you might want to use `G_URI_PARAMS_WWW_FORM` when parsing the
    /// params for a web URI, so compare the result of [`peek_scheme()`][Self::peek_scheme()]
    /// against `http` and `https`.
    ///
    /// ## Building URIs
    ///
    /// [`join()`][Self::join()] and [`join_with_user()`][Self::join_with_user()] can be used to construct
    /// valid URI strings from a set of component strings. They are the
    /// inverse of [`split()`][Self::split()] and [`split_with_user()`][Self::split_with_user()].
    ///
    /// Similarly, [`build()`][Self::build()] and [`build_with_user()`][Self::build_with_user()] can be
    /// used to construct a `GUri` from a set of component strings.
    ///
    /// As with the parsing functions, the building functions take a
    /// [`UriFlags`][crate::UriFlags] argument. In particular, it is important to keep in mind
    /// whether the URI components you are using are already `%`-encoded. If so,
    /// you must pass the `G_URI_FLAGS_ENCODED` flag.
    ///
    /// ## `file://` URIs
    ///
    /// Note that Windows and Unix both define special rules for parsing
    /// `file://` URIs (involving non-UTF-8 character sets on Unix, and the
    /// interpretation of path separators on Windows). `GUri` does not
    /// implement these rules. Use [`filename_from_uri()`][crate::filename_from_uri()] and
    /// [`filename_to_uri()`][crate::filename_to_uri()] if you want to properly convert between
    /// `file://` URIs and local filenames.
    ///
    /// ## URI Equality
    ///
    /// Note that there is no `g_uri_equal ()` function, because comparing
    /// URIs usefully requires scheme-specific knowledge that `GUri` does
    /// not have. `GUri` can help with normalization if you use the various
    /// encoded [`UriFlags`][crate::UriFlags] as well as `G_URI_FLAGS_SCHEME_NORMALIZE`
    /// however it is not comprehensive.
    /// For example, `data:,foo` and `data:;base64,Zm9v` resolve to the same
    /// thing according to the `data:` URI specification which GLib does not
    /// handle.
    // rustdoc-stripper-ignore-next-stop
    /// The `GUri` type and related functions can be used to parse URIs into
    /// their components, and build valid URIs from individual components.
    ///
    /// Since `GUri` only represents absolute URIs, all `GUri`s will have a
    /// URI scheme, so [`scheme()`][Self::scheme()] will always return a non-`NULL`
    /// answer. Likewise, by definition, all URIs have a path component, so
    /// [`path()`][Self::path()] will always return a non-`NULL` string (which may
    /// be empty).
    ///
    /// If the URI string has an
    /// [‘authority’ component](https://tools.ietf.org/html/rfc3986#section-3) (that
    /// is, if the scheme is followed by `://` rather than just `:`), then the
    /// `GUri` will contain a hostname, and possibly a port and ‘userinfo’.
    /// Additionally, depending on how the `GUri` was constructed/parsed (for example,
    /// using the `G_URI_FLAGS_HAS_PASSWORD` and `G_URI_FLAGS_HAS_AUTH_PARAMS` flags),
    /// the userinfo may be split out into a username, password, and
    /// additional authorization-related parameters.
    ///
    /// Normally, the components of a `GUri` will have all `%`-encoded
    /// characters decoded. However, if you construct/parse a `GUri` with
    /// `G_URI_FLAGS_ENCODED`, then the `%`-encoding will be preserved instead in
    /// the userinfo, path, and query fields (and in the host field if also
    /// created with `G_URI_FLAGS_NON_DNS`). In particular, this is necessary if
    /// the URI may contain binary data or non-UTF-8 text, or if decoding
    /// the components might change the interpretation of the URI.
    ///
    /// For example, with the encoded flag:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue", G_URI_FLAGS_ENCODED, &err);
    /// g_assert_cmpstr (g_uri_get_query (uri), ==, "query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue");
    /// ```
    ///
    /// While the default `%`-decoding behaviour would give:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue", G_URI_FLAGS_NONE, &err);
    /// g_assert_cmpstr (g_uri_get_query (uri), ==, "query=http://host/path?param=value");
    /// ```
    ///
    /// During decoding, if an invalid UTF-8 string is encountered, parsing will fail
    /// with an error indicating the bad string location:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fbad%3D%00alue", G_URI_FLAGS_NONE, &err);
    /// g_assert_error (err, G_URI_ERROR, G_URI_ERROR_BAD_QUERY);
    /// ```
    ///
    /// You should pass `G_URI_FLAGS_ENCODED` or `G_URI_FLAGS_ENCODED_QUERY` if you
    /// need to handle that case manually. In particular, if the query string
    /// contains `=` characters that are `%`-encoded, you should let
    /// `GLib::Uri::parse_params()` do the decoding once of the query.
    ///
    /// `GUri` is immutable once constructed, and can safely be accessed from
    /// multiple threads. Its reference counting is atomic.
    ///
    /// Note that the scope of `GUri` is to help manipulate URIs in various applications,
    /// following [RFC 3986](https://tools.ietf.org/html/rfc3986). In particular,
    /// it doesn't intend to cover web browser needs, and doesn’t implement the
    /// [WHATWG URL](https://url.spec.whatwg.org/) standard. No APIs are provided to
    /// help prevent
    /// [homograph attacks](https://en.wikipedia.org/wiki/IDN_homograph_attack), so
    /// `GUri` is not suitable for formatting URIs for display to the user for making
    /// security-sensitive decisions.
    ///
    /// ## Relative and absolute URIs
    ///
    /// As defined in [RFC 3986](https://tools.ietf.org/html/rfc3986#section-4), the
    /// hierarchical nature of URIs means that they can either be ‘relative
    /// references’ (sometimes referred to as ‘relative URIs’) or ‘URIs’ (for
    /// clarity, ‘URIs’ are referred to in this documentation as
    /// ‘absolute URIs’ — although
    /// [in contrast to RFC 3986](https://tools.ietf.org/html/rfc3986#section-4.3),
    /// fragment identifiers are always allowed).
    ///
    /// Relative references have one or more components of the URI missing. In
    /// particular, they have no scheme. Any other component, such as hostname,
    /// query, etc. may be missing, apart from a path, which has to be specified (but
    /// may be empty). The path may be relative, starting with `./` rather than `/`.
    ///
    /// For example, a valid relative reference is `./path?query`,
    /// `/?query#fragment` or `//example.com`.
    ///
    /// Absolute URIs have a scheme specified. Any other components of the URI which
    /// are missing are specified as explicitly unset in the URI, rather than being
    /// resolved relative to a base URI using [`parse_relative()`][Self::parse_relative()].
    ///
    /// For example, a valid absolute URI is `file:///home/bob` or
    /// `https://search.com?query=string`.
    ///
    /// A `GUri` instance is always an absolute URI. A string may be an absolute URI
    /// or a relative reference; see the documentation for individual functions as to
    /// what forms they accept.
    ///
    /// ## Parsing URIs
    ///
    /// The most minimalist APIs for parsing URIs are [`split()`][Self::split()] and
    /// [`split_with_user()`][Self::split_with_user()]. These split a URI into its component
    /// parts, and return the parts; the difference between the two is that
    /// [`split()`][Self::split()] treats the ‘userinfo’ component of the URI as a
    /// single element, while [`split_with_user()`][Self::split_with_user()] can (depending on the
    /// [`UriFlags`][crate::UriFlags] you pass) treat it as containing a username, password,
    /// and authentication parameters. Alternatively, [`split_network()`][Self::split_network()]
    /// can be used when you are only interested in the components that are
    /// needed to initiate a network connection to the service (scheme,
    /// host, and port).
    ///
    /// [`parse()`][Self::parse()] is similar to [`split()`][Self::split()], but instead of
    /// returning individual strings, it returns a `GUri` structure (and it requires
    /// that the URI be an absolute URI).
    ///
    /// [`resolve_relative()`][Self::resolve_relative()] and [`parse_relative()`][Self::parse_relative()] allow
    /// you to resolve a relative URI relative to a base URI.
    /// [`resolve_relative()`][Self::resolve_relative()] takes two strings and returns a string,
    /// and [`parse_relative()`][Self::parse_relative()] takes a `GUri` and a string and returns a
    /// `GUri`.
    ///
    /// All of the parsing functions take a [`UriFlags`][crate::UriFlags] argument describing
    /// exactly how to parse the URI; see the documentation for that type
    /// for more details on the specific flags that you can pass. If you
    /// need to choose different flags based on the type of URI, you can
    /// use [`peek_scheme()`][Self::peek_scheme()] on the URI string to check the scheme
    /// first, and use that to decide what flags to parse it with.
    ///
    /// For example, you might want to use `G_URI_PARAMS_WWW_FORM` when parsing the
    /// params for a web URI, so compare the result of [`peek_scheme()`][Self::peek_scheme()]
    /// against `http` and `https`.
    ///
    /// ## Building URIs
    ///
    /// [`join()`][Self::join()] and [`join_with_user()`][Self::join_with_user()] can be used to construct
    /// valid URI strings from a set of component strings. They are the
    /// inverse of [`split()`][Self::split()] and [`split_with_user()`][Self::split_with_user()].
    ///
    /// Similarly, [`build()`][Self::build()] and [`build_with_user()`][Self::build_with_user()] can be
    /// used to construct a `GUri` from a set of component strings.
    ///
    /// As with the parsing functions, the building functions take a
    /// [`UriFlags`][crate::UriFlags] argument. In particular, it is important to keep in mind
    /// whether the URI components you are using are already `%`-encoded. If so,
    /// you must pass the `G_URI_FLAGS_ENCODED` flag.
    ///
    /// ## `file://` URIs
    ///
    /// Note that Windows and Unix both define special rules for parsing
    /// `file://` URIs (involving non-UTF-8 character sets on Unix, and the
    /// interpretation of path separators on Windows). `GUri` does not
    /// implement these rules. Use [`filename_from_uri()`][crate::filename_from_uri()] and
    /// [`filename_to_uri()`][crate::filename_to_uri()] if you want to properly convert between
    /// `file://` URIs and local filenames.
    ///
    /// ## URI Equality
    ///
    /// Note that there is no `g_uri_equal ()` function, because comparing
    /// URIs usefully requires scheme-specific knowledge that `GUri` does
    /// not have. `GUri` can help with normalization if you use the various
    /// encoded [`UriFlags`][crate::UriFlags] as well as `G_URI_FLAGS_SCHEME_NORMALIZE`
    /// however it is not comprehensive.
    /// For example, `data:,foo` and `data:;base64,Zm9v` resolve to the same
    /// thing according to the `data:` URI specification which GLib does not
    /// handle.
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct Uri(Shared<ffi::GUri>);

    match fn {
        ref => |ptr| ffi::g_uri_ref(ptr),
        unref => |ptr| ffi::g_uri_unref(ptr),
        type_ => || ffi::g_uri_get_type(),
    }
}

impl Uri {
    /// Gets @self's authentication parameters, which may contain
    /// `%`-encoding, depending on the flags with which @self was created.
    /// (If @self was not created with [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS] then this will
    /// be [`None`].)
    ///
    /// Depending on the URI scheme, g_uri_parse_params() may be useful for
    /// further parsing this information.
    ///
    /// # Returns
    ///
    /// @self's authentication parameters.
    // rustdoc-stripper-ignore-next-stop
    /// Gets @self's authentication parameters, which may contain
    /// `%`-encoding, depending on the flags with which @self was created.
    /// (If @self was not created with [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS] then this will
    /// be [`None`].)
    ///
    /// Depending on the URI scheme, g_uri_parse_params() may be useful for
    /// further parsing this information.
    ///
    /// # Returns
    ///
    /// @self's authentication parameters.
    #[doc(alias = "g_uri_get_auth_params")]
    #[doc(alias = "get_auth_params")]
    pub fn auth_params(&self) -> Option<crate::GString> {
        unsafe { from_glib_none(ffi::g_uri_get_auth_params(self.to_glib_none().0)) }
    }

    /// Gets @self's flags set upon construction.
    ///
    /// # Returns
    ///
    /// @self's flags.
    // rustdoc-stripper-ignore-next-stop
    /// Gets @self's flags set upon construction.
    ///
    /// # Returns
    ///
    /// @self's flags.
    #[doc(alias = "g_uri_get_flags")]
    #[doc(alias = "get_flags")]
    pub fn flags(&self) -> UriFlags {
        unsafe { from_glib(ffi::g_uri_get_flags(self.to_glib_none().0)) }
    }

    /// Gets @self's fragment, which may contain `%`-encoding, depending on
    /// the flags with which @self was created.
    ///
    /// # Returns
    ///
    /// @self's fragment.
    // rustdoc-stripper-ignore-next-stop
    /// Gets @self's fragment, which may contain `%`-encoding, depending on
    /// the flags with which @self was created.
    ///
    /// # Returns
    ///
    /// @self's fragment.
    #[doc(alias = "g_uri_get_fragment")]
    #[doc(alias = "get_fragment")]
    pub fn fragment(&self) -> Option<crate::GString> {
        unsafe { from_glib_none(ffi::g_uri_get_fragment(self.to_glib_none().0)) }
    }

    /// Gets @self's host. This will never have `%`-encoded characters,
    /// unless it is non-UTF-8 (which can only be the case if @self was
    /// created with [`UriFlags::NON_DNS`][crate::UriFlags::NON_DNS]).
    ///
    /// If @self contained an IPv6 address literal, this value will be just
    /// that address, without the brackets around it that are necessary in
    /// the string form of the URI. Note that in this case there may also
    /// be a scope ID attached to the address. Eg, `fe80::1234%``em1` (or
    /// `fe80::1234%``25em1` if the string is still encoded).
    ///
    /// # Returns
    ///
    /// @self's host.
    // rustdoc-stripper-ignore-next-stop
    /// Gets @self's host. This will never have `%`-encoded characters,
    /// unless it is non-UTF-8 (which can only be the case if @self was
    /// created with [`UriFlags::NON_DNS`][crate::UriFlags::NON_DNS]).
    ///
    /// If @self contained an IPv6 address literal, this value will be just
    /// that address, without the brackets around it that are necessary in
    /// the string form of the URI. Note that in this case there may also
    /// be a scope ID attached to the address. Eg, `fe80::1234%``em1` (or
    /// `fe80::1234%``25em1` if the string is still encoded).
    ///
    /// # Returns
    ///
    /// @self's host.
    #[doc(alias = "g_uri_get_host")]
    #[doc(alias = "get_host")]
    pub fn host(&self) -> Option<crate::GString> {
        unsafe { from_glib_none(ffi::g_uri_get_host(self.to_glib_none().0)) }
    }

    /// Gets @self's password, which may contain `%`-encoding, depending on
    /// the flags with which @self was created. (If @self was not created
    /// with [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] then this will be [`None`].)
    ///
    /// # Returns
    ///
    /// @self's password.
    // rustdoc-stripper-ignore-next-stop
    /// Gets @self's password, which may contain `%`-encoding, depending on
    /// the flags with which @self was created. (If @self was not created
    /// with [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] then this will be [`None`].)
    ///
    /// # Returns
    ///
    /// @self's password.
    #[doc(alias = "g_uri_get_password")]
    #[doc(alias = "get_password")]
    pub fn password(&self) -> Option<crate::GString> {
        unsafe { from_glib_none(ffi::g_uri_get_password(self.to_glib_none().0)) }
    }

    /// Gets @self's path, which may contain `%`-encoding, depending on the
    /// flags with which @self was created.
    ///
    /// # Returns
    ///
    /// @self's path.
    // rustdoc-stripper-ignore-next-stop
    /// Gets @self's path, which may contain `%`-encoding, depending on the
    /// flags with which @self was created.
    ///
    /// # Returns
    ///
    /// @self's path.
    #[doc(alias = "g_uri_get_path")]
    #[doc(alias = "get_path")]
    pub fn path(&self) -> crate::GString {
        unsafe { from_glib_none(ffi::g_uri_get_path(self.to_glib_none().0)) }
    }

    /// Gets @self's port.
    ///
    /// # Returns
    ///
    /// @self's port, or `-1` if no port was specified.
    // rustdoc-stripper-ignore-next-stop
    /// Gets @self's port.
    ///
    /// # Returns
    ///
    /// @self's port, or `-1` if no port was specified.
    #[doc(alias = "g_uri_get_port")]
    #[doc(alias = "get_port")]
    pub fn port(&self) -> i32 {
        unsafe { ffi::g_uri_get_port(self.to_glib_none().0) }
    }

    /// Gets @self's query, which may contain `%`-encoding, depending on the
    /// flags with which @self was created.
    ///
    /// For queries consisting of a series of `name=value` parameters,
    /// #GUriParamsIter or g_uri_parse_params() may be useful.
    ///
    /// # Returns
    ///
    /// @self's query.
    // rustdoc-stripper-ignore-next-stop
    /// Gets @self's query, which may contain `%`-encoding, depending on the
    /// flags with which @self was created.
    ///
    /// For queries consisting of a series of `name=value` parameters,
    /// #GUriParamsIter or g_uri_parse_params() may be useful.
    ///
    /// # Returns
    ///
    /// @self's query.
    #[doc(alias = "g_uri_get_query")]
    #[doc(alias = "get_query")]
    pub fn query(&self) -> Option<crate::GString> {
        unsafe { from_glib_none(ffi::g_uri_get_query(self.to_glib_none().0)) }
    }

    /// Gets @self's scheme. Note that this will always be all-lowercase,
    /// regardless of the string or strings that @self was created from.
    ///
    /// # Returns
    ///
    /// @self's scheme.
    // rustdoc-stripper-ignore-next-stop
    /// Gets @self's scheme. Note that this will always be all-lowercase,
    /// regardless of the string or strings that @self was created from.
    ///
    /// # Returns
    ///
    /// @self's scheme.
    #[doc(alias = "g_uri_get_scheme")]
    #[doc(alias = "get_scheme")]
    pub fn scheme(&self) -> crate::GString {
        unsafe { from_glib_none(ffi::g_uri_get_scheme(self.to_glib_none().0)) }
    }

    /// Gets the ‘username’ component of @self's userinfo, which may contain
    /// `%`-encoding, depending on the flags with which @self was created.
    /// If @self was not created with [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] or
    /// [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS], this is the same as g_uri_get_userinfo().
    ///
    /// # Returns
    ///
    /// @self's user.
    // rustdoc-stripper-ignore-next-stop
    /// Gets the ‘username’ component of @self's userinfo, which may contain
    /// `%`-encoding, depending on the flags with which @self was created.
    /// If @self was not created with [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] or
    /// [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS], this is the same as g_uri_get_userinfo().
    ///
    /// # Returns
    ///
    /// @self's user.
    #[doc(alias = "g_uri_get_user")]
    #[doc(alias = "get_user")]
    pub fn user(&self) -> Option<crate::GString> {
        unsafe { from_glib_none(ffi::g_uri_get_user(self.to_glib_none().0)) }
    }

    /// Gets @self's userinfo, which may contain `%`-encoding, depending on
    /// the flags with which @self was created.
    ///
    /// # Returns
    ///
    /// @self's userinfo.
    // rustdoc-stripper-ignore-next-stop
    /// Gets @self's userinfo, which may contain `%`-encoding, depending on
    /// the flags with which @self was created.
    ///
    /// # Returns
    ///
    /// @self's userinfo.
    #[doc(alias = "g_uri_get_userinfo")]
    #[doc(alias = "get_userinfo")]
    pub fn userinfo(&self) -> Option<crate::GString> {
        unsafe { from_glib_none(ffi::g_uri_get_userinfo(self.to_glib_none().0)) }
    }

    /// Parses @uri_ref according to @flags and, if it is a
    /// [relative URI](#relative-and-absolute-uris), resolves it relative to @self.
    /// If the result is not a valid absolute URI, it will be discarded, and an error
    /// returned.
    /// ## `uri_ref`
    /// a string representing a relative or absolute URI
    /// ## `flags`
    /// flags describing how to parse @uri_ref
    ///
    /// # Returns
    ///
    /// a new #GUri, or NULL on error.
    // rustdoc-stripper-ignore-next-stop
    /// Parses @uri_ref according to @flags and, if it is a
    /// [relative URI](#relative-and-absolute-uris), resolves it relative to @self.
    /// If the result is not a valid absolute URI, it will be discarded, and an error
    /// returned.
    /// ## `uri_ref`
    /// a string representing a relative or absolute URI
    /// ## `flags`
    /// flags describing how to parse @uri_ref
    ///
    /// # Returns
    ///
    /// a new #GUri, or NULL on error.
    #[doc(alias = "g_uri_parse_relative")]
    pub fn parse_relative(&self, uri_ref: &str, flags: UriFlags) -> Result<Uri, crate::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::g_uri_parse_relative(
                self.to_glib_none().0,
                uri_ref.to_glib_none().0,
                flags.into_glib(),
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Returns a string representing @self.
    ///
    /// This is not guaranteed to return a string which is identical to the
    /// string that @self was parsed from. However, if the source URI was
    /// syntactically correct (according to RFC 3986), and it was parsed
    /// with [`UriFlags::ENCODED`][crate::UriFlags::ENCODED], then g_uri_to_string() is guaranteed to return
    /// a string which is at least semantically equivalent to the source
    /// URI (according to RFC 3986).
    ///
    /// If @self might contain sensitive details, such as authentication parameters,
    /// or private data in its query string, and the returned string is going to be
    /// logged, then consider using g_uri_to_string_partial() to redact parts.
    ///
    /// # Returns
    ///
    /// a string representing @self,
    ///     which the caller must free.
    // rustdoc-stripper-ignore-next-stop
    /// Returns a string representing @self.
    ///
    /// This is not guaranteed to return a string which is identical to the
    /// string that @self was parsed from. However, if the source URI was
    /// syntactically correct (according to RFC 3986), and it was parsed
    /// with [`UriFlags::ENCODED`][crate::UriFlags::ENCODED], then g_uri_to_string() is guaranteed to return
    /// a string which is at least semantically equivalent to the source
    /// URI (according to RFC 3986).
    ///
    /// If @self might contain sensitive details, such as authentication parameters,
    /// or private data in its query string, and the returned string is going to be
    /// logged, then consider using g_uri_to_string_partial() to redact parts.
    ///
    /// # Returns
    ///
    /// a string representing @self,
    ///     which the caller must free.
    #[doc(alias = "g_uri_to_string")]
    #[doc(alias = "to_string")]
    pub fn to_str(&self) -> crate::GString {
        unsafe { from_glib_full(ffi::g_uri_to_string(self.to_glib_none().0)) }
    }

    /// Returns a string representing @self, subject to the options in
    /// @flags. See g_uri_to_string() and #GUriHideFlags for more details.
    /// ## `flags`
    /// flags describing what parts of @self to hide
    ///
    /// # Returns
    ///
    /// a string representing
    ///     @self, which the caller must free.
    // rustdoc-stripper-ignore-next-stop
    /// Returns a string representing @self, subject to the options in
    /// @flags. See g_uri_to_string() and #GUriHideFlags for more details.
    /// ## `flags`
    /// flags describing what parts of @self to hide
    ///
    /// # Returns
    ///
    /// a string representing
    ///     @self, which the caller must free.
    #[doc(alias = "g_uri_to_string_partial")]
    pub fn to_string_partial(&self, flags: UriHideFlags) -> crate::GString {
        unsafe {
            from_glib_full(ffi::g_uri_to_string_partial(
                self.to_glib_none().0,
                flags.into_glib(),
            ))
        }
    }

    /// Creates a new #GUri from the given components according to @flags.
    ///
    /// See also g_uri_build_with_user(), which allows specifying the
    /// components of the "userinfo" separately.
    /// ## `flags`
    /// flags describing how to build the #GUri
    /// ## `scheme`
    /// the URI scheme
    /// ## `userinfo`
    /// the userinfo component, or [`None`]
    /// ## `host`
    /// the host component, or [`None`]
    /// ## `port`
    /// the port, or `-1`
    /// ## `path`
    /// the path component
    /// ## `query`
    /// the query component, or [`None`]
    /// ## `fragment`
    /// the fragment, or [`None`]
    ///
    /// # Returns
    ///
    /// a new #GUri
    // rustdoc-stripper-ignore-next-stop
    /// Creates a new #GUri from the given components according to @flags.
    ///
    /// See also g_uri_build_with_user(), which allows specifying the
    /// components of the "userinfo" separately.
    /// ## `flags`
    /// flags describing how to build the #GUri
    /// ## `scheme`
    /// the URI scheme
    /// ## `userinfo`
    /// the userinfo component, or [`None`]
    /// ## `host`
    /// the host component, or [`None`]
    /// ## `port`
    /// the port, or `-1`
    /// ## `path`
    /// the path component
    /// ## `query`
    /// the query component, or [`None`]
    /// ## `fragment`
    /// the fragment, or [`None`]
    ///
    /// # Returns
    ///
    /// a new #GUri
    #[doc(alias = "g_uri_build")]
    pub fn build(
        flags: UriFlags,
        scheme: &str,
        userinfo: Option<&str>,
        host: Option<&str>,
        port: i32,
        path: &str,
        query: Option<&str>,
        fragment: Option<&str>,
    ) -> Uri {
        unsafe {
            from_glib_full(ffi::g_uri_build(
                flags.into_glib(),
                scheme.to_glib_none().0,
                userinfo.to_glib_none().0,
                host.to_glib_none().0,
                port,
                path.to_glib_none().0,
                query.to_glib_none().0,
                fragment.to_glib_none().0,
            ))
        }
    }

    /// Creates a new #GUri from the given components according to @flags
    /// ([`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] is added unconditionally). The @flags must be
    /// coherent with the passed values, in particular use `%`-encoded values with
    /// [`UriFlags::ENCODED`][crate::UriFlags::ENCODED].
    ///
    /// In contrast to g_uri_build(), this allows specifying the components
    /// of the ‘userinfo’ field separately. Note that @user must be non-[`None`]
    /// if either @password or @auth_params is non-[`None`].
    /// ## `flags`
    /// flags describing how to build the #GUri
    /// ## `scheme`
    /// the URI scheme
    /// ## `user`
    /// the user component of the userinfo, or [`None`]
    /// ## `password`
    /// the password component of the userinfo, or [`None`]
    /// ## `auth_params`
    /// the auth params of the userinfo, or [`None`]
    /// ## `host`
    /// the host component, or [`None`]
    /// ## `port`
    /// the port, or `-1`
    /// ## `path`
    /// the path component
    /// ## `query`
    /// the query component, or [`None`]
    /// ## `fragment`
    /// the fragment, or [`None`]
    ///
    /// # Returns
    ///
    /// a new #GUri
    // rustdoc-stripper-ignore-next-stop
    /// Creates a new #GUri from the given components according to @flags
    /// ([`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] is added unconditionally). The @flags must be
    /// coherent with the passed values, in particular use `%`-encoded values with
    /// [`UriFlags::ENCODED`][crate::UriFlags::ENCODED].
    ///
    /// In contrast to g_uri_build(), this allows specifying the components
    /// of the ‘userinfo’ field separately. Note that @user must be non-[`None`]
    /// if either @password or @auth_params is non-[`None`].
    /// ## `flags`
    /// flags describing how to build the #GUri
    /// ## `scheme`
    /// the URI scheme
    /// ## `user`
    /// the user component of the userinfo, or [`None`]
    /// ## `password`
    /// the password component of the userinfo, or [`None`]
    /// ## `auth_params`
    /// the auth params of the userinfo, or [`None`]
    /// ## `host`
    /// the host component, or [`None`]
    /// ## `port`
    /// the port, or `-1`
    /// ## `path`
    /// the path component
    /// ## `query`
    /// the query component, or [`None`]
    /// ## `fragment`
    /// the fragment, or [`None`]
    ///
    /// # Returns
    ///
    /// a new #GUri
    #[doc(alias = "g_uri_build_with_user")]
    pub fn build_with_user(
        flags: UriFlags,
        scheme: &str,
        user: Option<&str>,
        password: Option<&str>,
        auth_params: Option<&str>,
        host: Option<&str>,
        port: i32,
        path: &str,
        query: Option<&str>,
        fragment: Option<&str>,
    ) -> Uri {
        unsafe {
            from_glib_full(ffi::g_uri_build_with_user(
                flags.into_glib(),
                scheme.to_glib_none().0,
                user.to_glib_none().0,
                password.to_glib_none().0,
                auth_params.to_glib_none().0,
                host.to_glib_none().0,
                port,
                path.to_glib_none().0,
                query.to_glib_none().0,
                fragment.to_glib_none().0,
            ))
        }
    }

    /// Escapes arbitrary data for use in a URI.
    ///
    /// Normally all characters that are not ‘unreserved’ (i.e. ASCII
    /// alphanumerical characters plus dash, dot, underscore and tilde) are
    /// escaped. But if you specify characters in @reserved_chars_allowed
    /// they are not escaped. This is useful for the ‘reserved’ characters
    /// in the URI specification, since those are allowed unescaped in some
    /// portions of a URI.
    ///
    /// Though technically incorrect, this will also allow escaping nul
    /// bytes as `%``00`.
    /// ## `unescaped`
    /// the unescaped input data.
    /// ## `reserved_chars_allowed`
    /// a string of reserved
    ///   characters that are allowed to be used, or [`None`].
    ///
    /// # Returns
    ///
    /// an escaped version of @unescaped.
    ///     The returned string should be freed when no longer needed.
    // rustdoc-stripper-ignore-next-stop
    /// Escapes arbitrary data for use in a URI.
    ///
    /// Normally all characters that are not ‘unreserved’ (i.e. ASCII
    /// alphanumerical characters plus dash, dot, underscore and tilde) are
    /// escaped. But if you specify characters in @reserved_chars_allowed
    /// they are not escaped. This is useful for the ‘reserved’ characters
    /// in the URI specification, since those are allowed unescaped in some
    /// portions of a URI.
    ///
    /// Though technically incorrect, this will also allow escaping nul
    /// bytes as `%``00`.
    /// ## `unescaped`
    /// the unescaped input data.
    /// ## `reserved_chars_allowed`
    /// a string of reserved
    ///   characters that are allowed to be used, or [`None`].
    ///
    /// # Returns
    ///
    /// an escaped version of @unescaped.
    ///     The returned string should be freed when no longer needed.
    #[doc(alias = "g_uri_escape_bytes")]
    pub fn escape_bytes(unescaped: &[u8], reserved_chars_allowed: Option<&str>) -> crate::GString {
        let length = unescaped.len() as _;
        unsafe {
            from_glib_full(ffi::g_uri_escape_bytes(
                unescaped.to_glib_none().0,
                length,
                reserved_chars_allowed.to_glib_none().0,
            ))
        }
    }

    /// Escapes a string for use in a URI.
    ///
    /// Normally all characters that are not "unreserved" (i.e. ASCII
    /// alphanumerical characters plus dash, dot, underscore and tilde) are
    /// escaped. But if you specify characters in @reserved_chars_allowed
    /// they are not escaped. This is useful for the "reserved" characters
    /// in the URI specification, since those are allowed unescaped in some
    /// portions of a URI.
    /// ## `unescaped`
    /// the unescaped input string.
    /// ## `reserved_chars_allowed`
    /// a string of reserved
    ///   characters that are allowed to be used, or [`None`].
    /// ## `allow_utf8`
    /// [`true`] if the result can include UTF-8 characters.
    ///
    /// # Returns
    ///
    /// an escaped version of @unescaped. The
    /// returned string should be freed when no longer needed.
    // rustdoc-stripper-ignore-next-stop
    /// Escapes a string for use in a URI.
    ///
    /// Normally all characters that are not "unreserved" (i.e. ASCII
    /// alphanumerical characters plus dash, dot, underscore and tilde) are
    /// escaped. But if you specify characters in @reserved_chars_allowed
    /// they are not escaped. This is useful for the "reserved" characters
    /// in the URI specification, since those are allowed unescaped in some
    /// portions of a URI.
    /// ## `unescaped`
    /// the unescaped input string.
    /// ## `reserved_chars_allowed`
    /// a string of reserved
    ///   characters that are allowed to be used, or [`None`].
    /// ## `allow_utf8`
    /// [`true`] if the result can include UTF-8 characters.
    ///
    /// # Returns
    ///
    /// an escaped version of @unescaped. The
    /// returned string should be freed when no longer needed.
    #[doc(alias = "g_uri_escape_string")]
    pub fn escape_string(
        unescaped: &str,
        reserved_chars_allowed: Option<&str>,
        allow_utf8: bool,
    ) -> crate::GString {
        unsafe {
            from_glib_full(ffi::g_uri_escape_string(
                unescaped.to_glib_none().0,
                reserved_chars_allowed.to_glib_none().0,
                allow_utf8.into_glib(),
            ))
        }
    }

    /// Parses @uri_string according to @flags, to determine whether it is a valid
    /// [absolute URI](#relative-and-absolute-uris), i.e. it does not need to be resolved
    /// relative to another URI using g_uri_parse_relative().
    ///
    /// If it’s not a valid URI, an error is returned explaining how it’s invalid.
    ///
    /// See g_uri_split(), and the definition of #GUriFlags, for more
    /// information on the effect of @flags.
    /// ## `uri_string`
    /// a string containing an absolute URI
    /// ## `flags`
    /// flags for parsing @uri_string
    ///
    /// # Returns
    ///
    /// [`true`] if @uri_string is a valid absolute URI, [`false`] on error.
    // rustdoc-stripper-ignore-next-stop
    /// Parses @uri_string according to @flags, to determine whether it is a valid
    /// [absolute URI](#relative-and-absolute-uris), i.e. it does not need to be resolved
    /// relative to another URI using g_uri_parse_relative().
    ///
    /// If it’s not a valid URI, an error is returned explaining how it’s invalid.
    ///
    /// See g_uri_split(), and the definition of #GUriFlags, for more
    /// information on the effect of @flags.
    /// ## `uri_string`
    /// a string containing an absolute URI
    /// ## `flags`
    /// flags for parsing @uri_string
    ///
    /// # Returns
    ///
    /// [`true`] if @uri_string is a valid absolute URI, [`false`] on error.
    #[doc(alias = "g_uri_is_valid")]
    pub fn is_valid(uri_string: &str, flags: UriFlags) -> Result<(), crate::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok =
                ffi::g_uri_is_valid(uri_string.to_glib_none().0, flags.into_glib(), &mut error);
            debug_assert_eq!(is_ok == crate::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Joins the given components together according to @flags to create
    /// an absolute URI string. @path may not be [`None`] (though it may be the empty
    /// string).
    ///
    /// When @host is present, @path must either be empty or begin with a slash (`/`)
    /// character. When @host is not present, @path cannot begin with two slash
    /// characters (`//`). See
    /// [RFC 3986, section 3](https://tools.ietf.org/html/rfc3986#section-3).
    ///
    /// See also g_uri_join_with_user(), which allows specifying the
    /// components of the ‘userinfo’ separately.
    ///
    /// [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] and [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS] are ignored if set
    /// in @flags.
    /// ## `flags`
    /// flags describing how to build the URI string
    /// ## `scheme`
    /// the URI scheme, or [`None`]
    /// ## `userinfo`
    /// the userinfo component, or [`None`]
    /// ## `host`
    /// the host component, or [`None`]
    /// ## `port`
    /// the port, or `-1`
    /// ## `path`
    /// the path component
    /// ## `query`
    /// the query component, or [`None`]
    /// ## `fragment`
    /// the fragment, or [`None`]
    ///
    /// # Returns
    ///
    /// an absolute URI string
    // rustdoc-stripper-ignore-next-stop
    /// Joins the given components together according to @flags to create
    /// an absolute URI string. @path may not be [`None`] (though it may be the empty
    /// string).
    ///
    /// When @host is present, @path must either be empty or begin with a slash (`/`)
    /// character. When @host is not present, @path cannot begin with two slash
    /// characters (`//`). See
    /// [RFC 3986, section 3](https://tools.ietf.org/html/rfc3986#section-3).
    ///
    /// See also g_uri_join_with_user(), which allows specifying the
    /// components of the ‘userinfo’ separately.
    ///
    /// [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] and [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS] are ignored if set
    /// in @flags.
    /// ## `flags`
    /// flags describing how to build the URI string
    /// ## `scheme`
    /// the URI scheme, or [`None`]
    /// ## `userinfo`
    /// the userinfo component, or [`None`]
    /// ## `host`
    /// the host component, or [`None`]
    /// ## `port`
    /// the port, or `-1`
    /// ## `path`
    /// the path component
    /// ## `query`
    /// the query component, or [`None`]
    /// ## `fragment`
    /// the fragment, or [`None`]
    ///
    /// # Returns
    ///
    /// an absolute URI string
    #[doc(alias = "g_uri_join")]
    pub fn join(
        flags: UriFlags,
        scheme: Option<&str>,
        userinfo: Option<&str>,
        host: Option<&str>,
        port: i32,
        path: &str,
        query: Option<&str>,
        fragment: Option<&str>,
    ) -> crate::GString {
        unsafe {
            from_glib_full(ffi::g_uri_join(
                flags.into_glib(),
                scheme.to_glib_none().0,
                userinfo.to_glib_none().0,
                host.to_glib_none().0,
                port,
                path.to_glib_none().0,
                query.to_glib_none().0,
                fragment.to_glib_none().0,
            ))
        }
    }

    /// Joins the given components together according to @flags to create
    /// an absolute URI string. @path may not be [`None`] (though it may be the empty
    /// string).
    ///
    /// In contrast to g_uri_join(), this allows specifying the components
    /// of the ‘userinfo’ separately. It otherwise behaves the same.
    ///
    /// [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] and [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS] are ignored if set
    /// in @flags.
    /// ## `flags`
    /// flags describing how to build the URI string
    /// ## `scheme`
    /// the URI scheme, or [`None`]
    /// ## `user`
    /// the user component of the userinfo, or [`None`]
    /// ## `password`
    /// the password component of the userinfo, or
    ///   [`None`]
    /// ## `auth_params`
    /// the auth params of the userinfo, or
    ///   [`None`]
    /// ## `host`
    /// the host component, or [`None`]
    /// ## `port`
    /// the port, or `-1`
    /// ## `path`
    /// the path component
    /// ## `query`
    /// the query component, or [`None`]
    /// ## `fragment`
    /// the fragment, or [`None`]
    ///
    /// # Returns
    ///
    /// an absolute URI string
    // rustdoc-stripper-ignore-next-stop
    /// Joins the given components together according to @flags to create
    /// an absolute URI string. @path may not be [`None`] (though it may be the empty
    /// string).
    ///
    /// In contrast to g_uri_join(), this allows specifying the components
    /// of the ‘userinfo’ separately. It otherwise behaves the same.
    ///
    /// [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] and [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS] are ignored if set
    /// in @flags.
    /// ## `flags`
    /// flags describing how to build the URI string
    /// ## `scheme`
    /// the URI scheme, or [`None`]
    /// ## `user`
    /// the user component of the userinfo, or [`None`]
    /// ## `password`
    /// the password component of the userinfo, or
    ///   [`None`]
    /// ## `auth_params`
    /// the auth params of the userinfo, or
    ///   [`None`]
    /// ## `host`
    /// the host component, or [`None`]
    /// ## `port`
    /// the port, or `-1`
    /// ## `path`
    /// the path component
    /// ## `query`
    /// the query component, or [`None`]
    /// ## `fragment`
    /// the fragment, or [`None`]
    ///
    /// # Returns
    ///
    /// an absolute URI string
    #[doc(alias = "g_uri_join_with_user")]
    pub fn join_with_user(
        flags: UriFlags,
        scheme: Option<&str>,
        user: Option<&str>,
        password: Option<&str>,
        auth_params: Option<&str>,
        host: Option<&str>,
        port: i32,
        path: &str,
        query: Option<&str>,
        fragment: Option<&str>,
    ) -> crate::GString {
        unsafe {
            from_glib_full(ffi::g_uri_join_with_user(
                flags.into_glib(),
                scheme.to_glib_none().0,
                user.to_glib_none().0,
                password.to_glib_none().0,
                auth_params.to_glib_none().0,
                host.to_glib_none().0,
                port,
                path.to_glib_none().0,
                query.to_glib_none().0,
                fragment.to_glib_none().0,
            ))
        }
    }

    /// Splits an URI list conforming to the text/uri-list
    /// mime type defined in RFC 2483 into individual URIs,
    /// discarding any comments. The URIs are not validated.
    /// ## `uri_list`
    /// an URI list
    ///
    /// # Returns
    ///
    /// a newly allocated [`None`]-terminated list
    ///   of strings holding the individual URIs. The array should be freed
    ///   with g_strfreev().
    // rustdoc-stripper-ignore-next-stop
    /// Splits an URI list conforming to the text/uri-list
    /// mime type defined in RFC 2483 into individual URIs,
    /// discarding any comments. The URIs are not validated.
    /// ## `uri_list`
    /// an URI list
    ///
    /// # Returns
    ///
    /// a newly allocated [`None`]-terminated list
    ///   of strings holding the individual URIs. The array should be freed
    ///   with g_strfreev().
    #[doc(alias = "g_uri_list_extract_uris")]
    pub fn list_extract_uris(uri_list: &str) -> Vec<crate::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::g_uri_list_extract_uris(
                uri_list.to_glib_none().0,
            ))
        }
    }

    /// Parses @uri_string according to @flags. If the result is not a
    /// valid [absolute URI](#relative-and-absolute-uris), it will be discarded, and an
    /// error returned.
    /// ## `uri_string`
    /// a string representing an absolute URI
    /// ## `flags`
    /// flags describing how to parse @uri_string
    ///
    /// # Returns
    ///
    /// a new #GUri, or NULL on error.
    // rustdoc-stripper-ignore-next-stop
    /// Parses @uri_string according to @flags. If the result is not a
    /// valid [absolute URI](#relative-and-absolute-uris), it will be discarded, and an
    /// error returned.
    /// ## `uri_string`
    /// a string representing an absolute URI
    /// ## `flags`
    /// flags describing how to parse @uri_string
    ///
    /// # Returns
    ///
    /// a new #GUri, or NULL on error.
    #[doc(alias = "g_uri_parse")]
    pub fn parse(uri_string: &str, flags: UriFlags) -> Result<Uri, crate::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::g_uri_parse(uri_string.to_glib_none().0, flags.into_glib(), &mut error);
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    //#[doc(alias = "g_uri_parse_params")]
    //pub fn parse_params(params: &str, separators: &str, flags: UriParamsFlags) -> Result</*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 0, id: 28 }/TypeId { ns_id: 0, id: 28 }, crate::Error> {
    //    unsafe { TODO: call ffi:g_uri_parse_params() }
    //}

    /// Gets the scheme portion of a URI string.
    /// [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) decodes the scheme
    /// as:
    ///
    /// ```text
    /// URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
    /// ```
    /// Common schemes include `file`, `https`, `svn+ssh`, etc.
    /// ## `uri`
    /// a valid URI.
    ///
    /// # Returns
    ///
    /// The ‘scheme’ component of the URI, or
    ///     [`None`] on error. The returned string should be freed when no longer needed.
    // rustdoc-stripper-ignore-next-stop
    /// Gets the scheme portion of a URI string.
    /// [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) decodes the scheme
    /// as:
    ///
    /// ```text
    /// URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
    /// ```
    /// Common schemes include `file`, `https`, `svn+ssh`, etc.
    /// ## `uri`
    /// a valid URI.
    ///
    /// # Returns
    ///
    /// The ‘scheme’ component of the URI, or
    ///     [`None`] on error. The returned string should be freed when no longer needed.
    #[doc(alias = "g_uri_parse_scheme")]
    pub fn parse_scheme(uri: &str) -> Option<crate::GString> {
        unsafe { from_glib_full(ffi::g_uri_parse_scheme(uri.to_glib_none().0)) }
    }

    /// Gets the scheme portion of a URI string.
    /// [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) decodes the scheme
    /// as:
    ///
    /// ```text
    /// URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
    /// ```
    /// Common schemes include `file`, `https`, `svn+ssh`, etc.
    ///
    /// Unlike g_uri_parse_scheme(), the returned scheme is normalized to
    /// all-lowercase and does not need to be freed.
    /// ## `uri`
    /// a valid URI.
    ///
    /// # Returns
    ///
    /// The ‘scheme’ component of the URI, or
    ///     [`None`] on error. The returned string is normalized to all-lowercase, and
    ///     interned via g_intern_string(), so it does not need to be freed.
    // rustdoc-stripper-ignore-next-stop
    /// Gets the scheme portion of a URI string.
    /// [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) decodes the scheme
    /// as:
    ///
    /// ```text
    /// URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
    /// ```
    /// Common schemes include `file`, `https`, `svn+ssh`, etc.
    ///
    /// Unlike g_uri_parse_scheme(), the returned scheme is normalized to
    /// all-lowercase and does not need to be freed.
    /// ## `uri`
    /// a valid URI.
    ///
    /// # Returns
    ///
    /// The ‘scheme’ component of the URI, or
    ///     [`None`] on error. The returned string is normalized to all-lowercase, and
    ///     interned via g_intern_string(), so it does not need to be freed.
    #[doc(alias = "g_uri_peek_scheme")]
    pub fn peek_scheme(uri: &str) -> Option<crate::GString> {
        unsafe { from_glib_none(ffi::g_uri_peek_scheme(uri.to_glib_none().0)) }
    }

    /// Parses @uri_ref according to @flags and, if it is a
    /// [relative URI](#relative-and-absolute-uris), resolves it relative to
    /// @base_uri_string. If the result is not a valid absolute URI, it will be
    /// discarded, and an error returned.
    ///
    /// (If @base_uri_string is [`None`], this just returns @uri_ref, or
    /// [`None`] if @uri_ref is invalid or not absolute.)
    /// ## `base_uri_string`
    /// a string representing a base URI
    /// ## `uri_ref`
    /// a string representing a relative or absolute URI
    /// ## `flags`
    /// flags describing how to parse @uri_ref
    ///
    /// # Returns
    ///
    /// the resolved URI string,
    /// or NULL on error.
    // rustdoc-stripper-ignore-next-stop
    /// Parses @uri_ref according to @flags and, if it is a
    /// [relative URI](#relative-and-absolute-uris), resolves it relative to
    /// @base_uri_string. If the result is not a valid absolute URI, it will be
    /// discarded, and an error returned.
    ///
    /// (If @base_uri_string is [`None`], this just returns @uri_ref, or
    /// [`None`] if @uri_ref is invalid or not absolute.)
    /// ## `base_uri_string`
    /// a string representing a base URI
    /// ## `uri_ref`
    /// a string representing a relative or absolute URI
    /// ## `flags`
    /// flags describing how to parse @uri_ref
    ///
    /// # Returns
    ///
    /// the resolved URI string,
    /// or NULL on error.
    #[doc(alias = "g_uri_resolve_relative")]
    pub fn resolve_relative(
        base_uri_string: Option<&str>,
        uri_ref: &str,
        flags: UriFlags,
    ) -> Result<crate::GString, crate::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::g_uri_resolve_relative(
                base_uri_string.to_glib_none().0,
                uri_ref.to_glib_none().0,
                flags.into_glib(),
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Parses @uri_ref (which can be an
    /// [absolute or relative URI](#relative-and-absolute-uris)) according to @flags, and
    /// returns the pieces. Any component that doesn't appear in @uri_ref will be
    /// returned as [`None`] (but note that all URIs always have a path component,
    /// though it may be the empty string).
    ///
    /// If @flags contains [`UriFlags::ENCODED`][crate::UriFlags::ENCODED], then `%`-encoded characters in
    /// @uri_ref will remain encoded in the output strings. (If not,
    /// then all such characters will be decoded.) Note that decoding will
    /// only work if the URI components are ASCII or UTF-8, so you will
    /// need to use [`UriFlags::ENCODED`][crate::UriFlags::ENCODED] if they are not.
    ///
    /// Note that the [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] and
    /// [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS] @flags are ignored by g_uri_split(),
    /// since it always returns only the full userinfo; use
    /// g_uri_split_with_user() if you want it split up.
    /// ## `uri_ref`
    /// a string containing a relative or absolute URI
    /// ## `flags`
    /// flags for parsing @uri_ref
    ///
    /// # Returns
    ///
    /// [`true`] if @uri_ref parsed successfully, [`false`]
    ///   on error.
    ///
    /// ## `scheme`
    /// on return, contains
    ///    the scheme (converted to lowercase), or [`None`]
    ///
    /// ## `userinfo`
    /// on return, contains
    ///    the userinfo, or [`None`]
    ///
    /// ## `host`
    /// on return, contains the
    ///    host, or [`None`]
    ///
    /// ## `port`
    /// on return, contains the
    ///    port, or `-1`
    ///
    /// ## `path`
    /// on return, contains the
    ///    path
    ///
    /// ## `query`
    /// on return, contains the
    ///    query, or [`None`]
    ///
    /// ## `fragment`
    /// on return, contains
    ///    the fragment, or [`None`]
    // rustdoc-stripper-ignore-next-stop
    /// Parses @uri_ref (which can be an
    /// [absolute or relative URI](#relative-and-absolute-uris)) according to @flags, and
    /// returns the pieces. Any component that doesn't appear in @uri_ref will be
    /// returned as [`None`] (but note that all URIs always have a path component,
    /// though it may be the empty string).
    ///
    /// If @flags contains [`UriFlags::ENCODED`][crate::UriFlags::ENCODED], then `%`-encoded characters in
    /// @uri_ref will remain encoded in the output strings. (If not,
    /// then all such characters will be decoded.) Note that decoding will
    /// only work if the URI components are ASCII or UTF-8, so you will
    /// need to use [`UriFlags::ENCODED`][crate::UriFlags::ENCODED] if they are not.
    ///
    /// Note that the [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD] and
    /// [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS] @flags are ignored by g_uri_split(),
    /// since it always returns only the full userinfo; use
    /// g_uri_split_with_user() if you want it split up.
    /// ## `uri_ref`
    /// a string containing a relative or absolute URI
    /// ## `flags`
    /// flags for parsing @uri_ref
    ///
    /// # Returns
    ///
    /// [`true`] if @uri_ref parsed successfully, [`false`]
    ///   on error.
    ///
    /// ## `scheme`
    /// on return, contains
    ///    the scheme (converted to lowercase), or [`None`]
    ///
    /// ## `userinfo`
    /// on return, contains
    ///    the userinfo, or [`None`]
    ///
    /// ## `host`
    /// on return, contains the
    ///    host, or [`None`]
    ///
    /// ## `port`
    /// on return, contains the
    ///    port, or `-1`
    ///
    /// ## `path`
    /// on return, contains the
    ///    path
    ///
    /// ## `query`
    /// on return, contains the
    ///    query, or [`None`]
    ///
    /// ## `fragment`
    /// on return, contains
    ///    the fragment, or [`None`]
    #[doc(alias = "g_uri_split")]
    pub fn split(
        uri_ref: &str,
        flags: UriFlags,
    ) -> Result<
        (
            Option<crate::GString>,
            Option<crate::GString>,
            Option<crate::GString>,
            i32,
            crate::GString,
            Option<crate::GString>,
            Option<crate::GString>,
        ),
        crate::Error,
    > {
        unsafe {
            let mut scheme = std::ptr::null_mut();
            let mut userinfo = std::ptr::null_mut();
            let mut host = std::ptr::null_mut();
            let mut port = std::mem::MaybeUninit::uninit();
            let mut path = std::ptr::null_mut();
            let mut query = std::ptr::null_mut();
            let mut fragment = std::ptr::null_mut();
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::g_uri_split(
                uri_ref.to_glib_none().0,
                flags.into_glib(),
                &mut scheme,
                &mut userinfo,
                &mut host,
                port.as_mut_ptr(),
                &mut path,
                &mut query,
                &mut fragment,
                &mut error,
            );
            debug_assert_eq!(is_ok == crate::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok((
                    from_glib_full(scheme),
                    from_glib_full(userinfo),
                    from_glib_full(host),
                    port.assume_init(),
                    from_glib_full(path),
                    from_glib_full(query),
                    from_glib_full(fragment),
                ))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Parses @uri_string (which must be an [absolute URI](#relative-and-absolute-uris))
    /// according to @flags, and returns the pieces relevant to connecting to a host.
    /// See the documentation for g_uri_split() for more details; this is
    /// mostly a wrapper around that function with simpler arguments.
    /// However, it will return an error if @uri_string is a relative URI,
    /// or does not contain a hostname component.
    /// ## `uri_string`
    /// a string containing an absolute URI
    /// ## `flags`
    /// flags for parsing @uri_string
    ///
    /// # Returns
    ///
    /// [`true`] if @uri_string parsed successfully,
    ///   [`false`] on error.
    ///
    /// ## `scheme`
    /// on return, contains
    ///    the scheme (converted to lowercase), or [`None`]
    ///
    /// ## `host`
    /// on return, contains the
    ///    host, or [`None`]
    ///
    /// ## `port`
    /// on return, contains the
    ///    port, or `-1`
    // rustdoc-stripper-ignore-next-stop
    /// Parses @uri_string (which must be an [absolute URI](#relative-and-absolute-uris))
    /// according to @flags, and returns the pieces relevant to connecting to a host.
    /// See the documentation for g_uri_split() for more details; this is
    /// mostly a wrapper around that function with simpler arguments.
    /// However, it will return an error if @uri_string is a relative URI,
    /// or does not contain a hostname component.
    /// ## `uri_string`
    /// a string containing an absolute URI
    /// ## `flags`
    /// flags for parsing @uri_string
    ///
    /// # Returns
    ///
    /// [`true`] if @uri_string parsed successfully,
    ///   [`false`] on error.
    ///
    /// ## `scheme`
    /// on return, contains
    ///    the scheme (converted to lowercase), or [`None`]
    ///
    /// ## `host`
    /// on return, contains the
    ///    host, or [`None`]
    ///
    /// ## `port`
    /// on return, contains the
    ///    port, or `-1`
    #[doc(alias = "g_uri_split_network")]
    pub fn split_network(
        uri_string: &str,
        flags: UriFlags,
    ) -> Result<(Option<crate::GString>, Option<crate::GString>, i32), crate::Error> {
        unsafe {
            let mut scheme = std::ptr::null_mut();
            let mut host = std::ptr::null_mut();
            let mut port = std::mem::MaybeUninit::uninit();
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::g_uri_split_network(
                uri_string.to_glib_none().0,
                flags.into_glib(),
                &mut scheme,
                &mut host,
                port.as_mut_ptr(),
                &mut error,
            );
            debug_assert_eq!(is_ok == crate::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok((
                    from_glib_full(scheme),
                    from_glib_full(host),
                    port.assume_init(),
                ))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Parses @uri_ref (which can be an
    /// [absolute or relative URI](#relative-and-absolute-uris)) according to @flags, and
    /// returns the pieces. Any component that doesn't appear in @uri_ref will be
    /// returned as [`None`] (but note that all URIs always have a path component,
    /// though it may be the empty string).
    ///
    /// See g_uri_split(), and the definition of #GUriFlags, for more
    /// information on the effect of @flags. Note that @password will only
    /// be parsed out if @flags contains [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD], and
    /// @auth_params will only be parsed out if @flags contains
    /// [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS].
    /// ## `uri_ref`
    /// a string containing a relative or absolute URI
    /// ## `flags`
    /// flags for parsing @uri_ref
    ///
    /// # Returns
    ///
    /// [`true`] if @uri_ref parsed successfully, [`false`]
    ///   on error.
    ///
    /// ## `scheme`
    /// on return, contains
    ///    the scheme (converted to lowercase), or [`None`]
    ///
    /// ## `user`
    /// on return, contains
    ///    the user, or [`None`]
    ///
    /// ## `password`
    /// on return, contains
    ///    the password, or [`None`]
    ///
    /// ## `auth_params`
    /// on return, contains
    ///    the auth_params, or [`None`]
    ///
    /// ## `host`
    /// on return, contains the
    ///    host, or [`None`]
    ///
    /// ## `port`
    /// on return, contains the
    ///    port, or `-1`
    ///
    /// ## `path`
    /// on return, contains the
    ///    path
    ///
    /// ## `query`
    /// on return, contains the
    ///    query, or [`None`]
    ///
    /// ## `fragment`
    /// on return, contains
    ///    the fragment, or [`None`]
    // rustdoc-stripper-ignore-next-stop
    /// Parses @uri_ref (which can be an
    /// [absolute or relative URI](#relative-and-absolute-uris)) according to @flags, and
    /// returns the pieces. Any component that doesn't appear in @uri_ref will be
    /// returned as [`None`] (but note that all URIs always have a path component,
    /// though it may be the empty string).
    ///
    /// See g_uri_split(), and the definition of #GUriFlags, for more
    /// information on the effect of @flags. Note that @password will only
    /// be parsed out if @flags contains [`UriFlags::HAS_PASSWORD`][crate::UriFlags::HAS_PASSWORD], and
    /// @auth_params will only be parsed out if @flags contains
    /// [`UriFlags::HAS_AUTH_PARAMS`][crate::UriFlags::HAS_AUTH_PARAMS].
    /// ## `uri_ref`
    /// a string containing a relative or absolute URI
    /// ## `flags`
    /// flags for parsing @uri_ref
    ///
    /// # Returns
    ///
    /// [`true`] if @uri_ref parsed successfully, [`false`]
    ///   on error.
    ///
    /// ## `scheme`
    /// on return, contains
    ///    the scheme (converted to lowercase), or [`None`]
    ///
    /// ## `user`
    /// on return, contains
    ///    the user, or [`None`]
    ///
    /// ## `password`
    /// on return, contains
    ///    the password, or [`None`]
    ///
    /// ## `auth_params`
    /// on return, contains
    ///    the auth_params, or [`None`]
    ///
    /// ## `host`
    /// on return, contains the
    ///    host, or [`None`]
    ///
    /// ## `port`
    /// on return, contains the
    ///    port, or `-1`
    ///
    /// ## `path`
    /// on return, contains the
    ///    path
    ///
    /// ## `query`
    /// on return, contains the
    ///    query, or [`None`]
    ///
    /// ## `fragment`
    /// on return, contains
    ///    the fragment, or [`None`]
    #[doc(alias = "g_uri_split_with_user")]
    pub fn split_with_user(
        uri_ref: &str,
        flags: UriFlags,
    ) -> Result<
        (
            Option<crate::GString>,
            Option<crate::GString>,
            Option<crate::GString>,
            Option<crate::GString>,
            Option<crate::GString>,
            i32,
            crate::GString,
            Option<crate::GString>,
            Option<crate::GString>,
        ),
        crate::Error,
    > {
        unsafe {
            let mut scheme = std::ptr::null_mut();
            let mut user = std::ptr::null_mut();
            let mut password = std::ptr::null_mut();
            let mut auth_params = std::ptr::null_mut();
            let mut host = std::ptr::null_mut();
            let mut port = std::mem::MaybeUninit::uninit();
            let mut path = std::ptr::null_mut();
            let mut query = std::ptr::null_mut();
            let mut fragment = std::ptr::null_mut();
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::g_uri_split_with_user(
                uri_ref.to_glib_none().0,
                flags.into_glib(),
                &mut scheme,
                &mut user,
                &mut password,
                &mut auth_params,
                &mut host,
                port.as_mut_ptr(),
                &mut path,
                &mut query,
                &mut fragment,
                &mut error,
            );
            debug_assert_eq!(is_ok == crate::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok((
                    from_glib_full(scheme),
                    from_glib_full(user),
                    from_glib_full(password),
                    from_glib_full(auth_params),
                    from_glib_full(host),
                    port.assume_init(),
                    from_glib_full(path),
                    from_glib_full(query),
                    from_glib_full(fragment),
                ))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Unescapes a segment of an escaped string as binary data.
    ///
    /// Note that in contrast to g_uri_unescape_string(), this does allow
    /// nul bytes to appear in the output.
    ///
    /// If any of the characters in @illegal_characters appears as an escaped
    /// character in @escaped_string, then that is an error and [`None`] will be
    /// returned. This is useful if you want to avoid for instance having a slash
    /// being expanded in an escaped path element, which might confuse pathname
    /// handling.
    /// ## `escaped_string`
    /// A URI-escaped string
    /// ## `length`
    /// the length (in bytes) of @escaped_string to escape, or `-1` if it
    ///   is nul-terminated.
    /// ## `illegal_characters`
    /// a string of illegal characters
    ///   not to be allowed, or [`None`].
    ///
    /// # Returns
    ///
    /// an unescaped version of @escaped_string
    ///     or [`None`] on error (if decoding failed, using [`UriError::Failed`][crate::UriError::Failed] error
    ///     code). The returned #GBytes should be unreffed when no longer needed.
    // rustdoc-stripper-ignore-next-stop
    /// Unescapes a segment of an escaped string as binary data.
    ///
    /// Note that in contrast to g_uri_unescape_string(), this does allow
    /// nul bytes to appear in the output.
    ///
    /// If any of the characters in @illegal_characters appears as an escaped
    /// character in @escaped_string, then that is an error and [`None`] will be
    /// returned. This is useful if you want to avoid for instance having a slash
    /// being expanded in an escaped path element, which might confuse pathname
    /// handling.
    /// ## `escaped_string`
    /// A URI-escaped string
    /// ## `length`
    /// the length (in bytes) of @escaped_string to escape, or `-1` if it
    ///   is nul-terminated.
    /// ## `illegal_characters`
    /// a string of illegal characters
    ///   not to be allowed, or [`None`].
    ///
    /// # Returns
    ///
    /// an unescaped version of @escaped_string
    ///     or [`None`] on error (if decoding failed, using [`UriError::Failed`][crate::UriError::Failed] error
    ///     code). The returned #GBytes should be unreffed when no longer needed.
    #[doc(alias = "g_uri_unescape_bytes")]
    pub fn unescape_bytes(
        escaped_string: &str,
        illegal_characters: Option<&str>,
    ) -> Result<Bytes, crate::Error> {
        let length = escaped_string.len() as _;
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::g_uri_unescape_bytes(
                escaped_string.to_glib_none().0,
                length,
                illegal_characters.to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Unescapes a segment of an escaped string.
    ///
    /// If any of the characters in @illegal_characters or the NUL
    /// character appears as an escaped character in @escaped_string, then
    /// that is an error and [`None`] will be returned. This is useful if you
    /// want to avoid for instance having a slash being expanded in an
    /// escaped path element, which might confuse pathname handling.
    ///
    /// Note: `NUL` byte is not accepted in the output, in contrast to
    /// g_uri_unescape_bytes().
    /// ## `escaped_string`
    /// A string, may be [`None`]
    /// ## `escaped_string_end`
    /// Pointer to end of @escaped_string,
    ///   may be [`None`]
    /// ## `illegal_characters`
    /// An optional string of illegal
    ///   characters not to be allowed, may be [`None`]
    ///
    /// # Returns
    ///
    /// an unescaped version of @escaped_string,
    /// or [`None`] on error. The returned string should be freed when no longer
    /// needed.  As a special case if [`None`] is given for @escaped_string, this
    /// function will return [`None`].
    // rustdoc-stripper-ignore-next-stop
    /// Unescapes a segment of an escaped string.
    ///
    /// If any of the characters in @illegal_characters or the NUL
    /// character appears as an escaped character in @escaped_string, then
    /// that is an error and [`None`] will be returned. This is useful if you
    /// want to avoid for instance having a slash being expanded in an
    /// escaped path element, which might confuse pathname handling.
    ///
    /// Note: `NUL` byte is not accepted in the output, in contrast to
    /// g_uri_unescape_bytes().
    /// ## `escaped_string`
    /// A string, may be [`None`]
    /// ## `escaped_string_end`
    /// Pointer to end of @escaped_string,
    ///   may be [`None`]
    /// ## `illegal_characters`
    /// An optional string of illegal
    ///   characters not to be allowed, may be [`None`]
    ///
    /// # Returns
    ///
    /// an unescaped version of @escaped_string,
    /// or [`None`] on error. The returned string should be freed when no longer
    /// needed.  As a special case if [`None`] is given for @escaped_string, this
    /// function will return [`None`].
    #[doc(alias = "g_uri_unescape_segment")]
    pub fn unescape_segment(
        escaped_string: Option<&str>,
        escaped_string_end: Option<&str>,
        illegal_characters: Option<&str>,
    ) -> Option<crate::GString> {
        unsafe {
            from_glib_full(ffi::g_uri_unescape_segment(
                escaped_string.to_glib_none().0,
                escaped_string_end.to_glib_none().0,
                illegal_characters.to_glib_none().0,
            ))
        }
    }

    /// Unescapes a whole escaped string.
    ///
    /// If any of the characters in @illegal_characters or the NUL
    /// character appears as an escaped character in @escaped_string, then
    /// that is an error and [`None`] will be returned. This is useful if you
    /// want to avoid for instance having a slash being expanded in an
    /// escaped path element, which might confuse pathname handling.
    /// ## `escaped_string`
    /// an escaped string to be unescaped.
    /// ## `illegal_characters`
    /// a string of illegal characters
    ///   not to be allowed, or [`None`].
    ///
    /// # Returns
    ///
    /// an unescaped version of @escaped_string.
    /// The returned string should be freed when no longer needed.
    // rustdoc-stripper-ignore-next-stop
    /// Unescapes a whole escaped string.
    ///
    /// If any of the characters in @illegal_characters or the NUL
    /// character appears as an escaped character in @escaped_string, then
    /// that is an error and [`None`] will be returned. This is useful if you
    /// want to avoid for instance having a slash being expanded in an
    /// escaped path element, which might confuse pathname handling.
    /// ## `escaped_string`
    /// an escaped string to be unescaped.
    /// ## `illegal_characters`
    /// a string of illegal characters
    ///   not to be allowed, or [`None`].
    ///
    /// # Returns
    ///
    /// an unescaped version of @escaped_string.
    /// The returned string should be freed when no longer needed.
    #[doc(alias = "g_uri_unescape_string")]
    pub fn unescape_string(
        escaped_string: &str,
        illegal_characters: Option<&str>,
    ) -> Option<crate::GString> {
        unsafe {
            from_glib_full(ffi::g_uri_unescape_string(
                escaped_string.to_glib_none().0,
                illegal_characters.to_glib_none().0,
            ))
        }
    }
}

impl std::fmt::Display for Uri {
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.write_str(&self.to_str())
    }
}

unsafe impl Send for Uri {}
unsafe impl Sync for Uri {}