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
// 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::translate::*;
use crate::Bytes;
use crate::Error;
use crate::UriFlags;
use crate::UriHideFlags;
use std::fmt;
use std::mem;
use std::ptr;
crate::wrapper! {
#[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 {
#[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)) }
}
#[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)) }
}
#[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)) }
}
#[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)) }
}
#[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)) }
}
#[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)) }
}
#[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) }
}
#[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)) }
}
#[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)) }
}
#[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)) }
}
#[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)) }
}
#[doc(alias = "g_uri_parse_relative")]
pub fn parse_relative(&self, uri_ref: &str, flags: UriFlags) -> Result<Uri, crate::Error> {
unsafe {
let mut error = 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))
}
}
}
#[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)) }
}
#[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(),
))
}
}
#[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,
))
}
}
#[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,
))
}
}
#[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,
))
}
}
#[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(),
))
}
}
#[doc(alias = "g_uri_is_valid")]
pub fn is_valid(uri_string: &str, flags: UriFlags) -> Result<(), crate::Error> {
unsafe {
let mut error = ptr::null_mut();
let is_ok =
ffi::g_uri_is_valid(uri_string.to_glib_none().0, flags.into_glib(), &mut error);
assert_eq!(is_ok == crate::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
#[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,
))
}
}
#[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,
))
}
}
#[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-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 [`Uri`][crate::Uri], 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 = 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.
#[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 [`parse_scheme()`][Self::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-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 = 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-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 [`split()`][Self::split()],
/// since it always returns only the full userinfo; use
/// [`split_with_user()`][Self::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 = ptr::null_mut();
let mut userinfo = ptr::null_mut();
let mut host = ptr::null_mut();
let mut port = mem::MaybeUninit::uninit();
let mut path = ptr::null_mut();
let mut query = ptr::null_mut();
let mut fragment = ptr::null_mut();
let mut error = 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,
);
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-absolute-uris])
/// according to `flags`, and returns the pieces relevant to connecting to a host.
/// See the documentation for [`split()`][Self::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 = ptr::null_mut();
let mut host = ptr::null_mut();
let mut port = mem::MaybeUninit::uninit();
let mut error = 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,
);
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-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 [`split()`][Self::split()], and the definition of [`UriFlags`][crate::UriFlags], 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 = ptr::null_mut();
let mut user = ptr::null_mut();
let mut password = ptr::null_mut();
let mut auth_params = ptr::null_mut();
let mut host = ptr::null_mut();
let mut port = mem::MaybeUninit::uninit();
let mut path = ptr::null_mut();
let mut query = ptr::null_mut();
let mut fragment = ptr::null_mut();
let mut error = 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,
);
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 [`unescape_string()`][Self::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 [`Bytes`][crate::Bytes] 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 = 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
/// [`unescape_bytes()`][Self::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.
#[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 fmt::Display for Uri {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str(&self.to_str())
}
}
unsafe impl Send for Uri {}
unsafe impl Sync for Uri {}