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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT
#![allow(deprecated)]
#[cfg(feature = "v1_3_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3_3")))]
use crate::QueryFlags;
use crate::{ffi, InstalledRef, Ref, RefKind, RelatedRef, Remote, RemoteRef, StorageType};
use glib::{prelude::*, translate::*};
glib::wrapper! {
///
///
/// # Implements
///
/// [`InstallationExt`][trait@crate::prelude::InstallationExt], [`InstallationExtManual`][trait@crate::prelude::InstallationExtManual]
#[doc(alias = "FlatpakInstallation")]
pub struct Installation(Object<ffi::FlatpakInstallation, ffi::FlatpakInstallationClass>);
match fn {
type_ => || ffi::flatpak_installation_get_type(),
}
}
impl Installation {
pub const NONE: Option<&'static Installation> = None;
/// Creates a new [`Installation`][crate::Installation] for the installation at the given `path`.
/// ## `path`
/// a [`gio::File`][crate::gio::File]
/// ## `user`
/// whether this is a user-specific location
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a new [`Installation`][crate::Installation]
#[doc(alias = "flatpak_installation_new_for_path")]
#[doc(alias = "new_for_path")]
pub fn for_path(
path: &impl IsA<gio::File>,
user: bool,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Installation, glib::Error> {
assert_initialized_main_thread!();
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_new_for_path(
path.as_ref().to_glib_none().0,
user.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Creates a new [`Installation`][crate::Installation] for the default system-wide installation.
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a new [`Installation`][crate::Installation]
#[doc(alias = "flatpak_installation_new_system")]
pub fn new_system(
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Installation, glib::Error> {
assert_initialized_main_thread!();
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_new_system(
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Creates a new [`Installation`][crate::Installation] for the system-wide installation `id`.
/// ## `id`
/// the ID of the system-wide installation
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a new [`Installation`][crate::Installation]
#[doc(alias = "flatpak_installation_new_system_with_id")]
pub fn new_system_with_id(
id: Option<&str>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Installation, glib::Error> {
assert_initialized_main_thread!();
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_new_system_with_id(
id.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Creates a new [`Installation`][crate::Installation] for the per-user installation.
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a new [`Installation`][crate::Installation]
#[doc(alias = "flatpak_installation_new_user")]
pub fn new_user(
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Installation, glib::Error> {
assert_initialized_main_thread!();
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_new_user(
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::Installation>> Sealed for T {}
}
/// Trait containing all [`struct@Installation`] methods.
///
/// # Implementors
///
/// [`Installation`][struct@crate::Installation]
pub trait InstallationExt: IsA<Installation> + sealed::Sealed + 'static {
/// Adds a new `remote` object to the set of remotes. This is similar
/// to [`modify_remote()`][Self::modify_remote()] for non-existing remote
/// names. However, if the named remote already exists then instead of
/// modifying it it fails with [`Error::AlreadyInstalled`][crate::Error::AlreadyInstalled], or if
/// `if_needed` is true it silently succeeds without doing anything.
///
/// As an exception to the last, if the local config has a filter defined,
/// but the new remote unsets the filter (for example, it comes from an
/// unfiltered .flatpakref via [`Remote::from_file()`][crate::Remote::from_file()]) the the local
/// remote filter gets reset. This is to allow the setup where there is a
/// default setup of a filtered remote, yet you can still use the standard
/// flatpakref file to get the full contents without getting two remotes.
/// ## `remote`
/// the new [`Remote`][crate::Remote]
/// ## `if_needed`
/// if [`true`], only add if it doesn't exists
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`] if the modifications have been committed successfully
#[cfg(feature = "v1_3_4")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3_4")))]
#[doc(alias = "flatpak_installation_add_remote")]
fn add_remote(
&self,
remote: &impl IsA<Remote>,
if_needed: bool,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_add_remote(
self.as_ref().to_glib_none().0,
remote.as_ref().to_glib_none().0,
if_needed.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Remove all OSTree refs from the local flatpak repository which are not
/// in a deployed state. The next time the underlying OSTree repo is pruned,
/// objects which were attached to that ref will be removed. This is useful if
/// you pulled a flatpak refs using [`InstallationExtManual::install_full()`][crate::prelude::InstallationExtManual::install_full()] and
/// specified [`InstallFlags::NO_DEPLOY`][crate::InstallFlags::NO_DEPLOY] but then decided not to
/// deploy the refs later on and want to remove the local refs to prevent them
/// from taking up disk space. Note that this will not remove the objects
/// referred to by `ref_` from the underlying OSTree repo, you should use
/// [`prune_local_repo()`][Self::prune_local_repo()] to do that.
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`] on success
#[doc(alias = "flatpak_installation_cleanup_local_refs_sync")]
fn cleanup_local_refs_sync(
&self,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_cleanup_local_refs_sync(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Gets monitor object for the installation. The returned file monitor will
/// emit the [`changed`][struct@crate::gio::FileMonitor#changed] signal whenever an application or runtime
/// was installed, uninstalled or updated.
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a new [`gio::FileMonitor`][crate::gio::FileMonitor] instance, or [`None`] on error
#[doc(alias = "flatpak_installation_create_monitor")]
fn create_monitor(
&self,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<gio::FileMonitor, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_create_monitor(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Drops all internal (in-memory) caches. For instance, this may be needed to pick up new or changed
/// remotes configured outside this installation instance.
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`] on success, [`false`] on error
#[doc(alias = "flatpak_installation_drop_caches")]
fn drop_caches(
&self,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_drop_caches(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Obtains the metadata file from a commit.
///
/// NOTE: Since 0.11.4 this information is accessible in FlatpakRemoteRef, so this
/// function is not very useful anymore.
/// ## `remote_name`
/// the name of the remote
/// ## `ref_`
/// the ref
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a [`glib::Bytes`][crate::glib::Bytes] containing the flatpak metadata file,
/// or [`None`] if an error occurred
#[doc(alias = "flatpak_installation_fetch_remote_metadata_sync")]
fn fetch_remote_metadata_sync(
&self,
remote_name: &str,
ref_: &impl IsA<Ref>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<glib::Bytes, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_fetch_remote_metadata_sync(
self.as_ref().to_glib_none().0,
remote_name.to_glib_none().0,
ref_.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Gets the current remote branch of a ref in the remote.
/// ## `remote_name`
/// the name of the remote
/// ## `kind`
/// what this ref contains (an [`RefKind`][crate::RefKind])
/// ## `name`
/// name of the app/runtime to fetch
/// ## `arch`
/// which architecture to fetch (default: current architecture)
/// ## `branch`
/// which branch to fetch (default: 'master')
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a [`RemoteRef`][crate::RemoteRef] instance, or [`None`]
#[doc(alias = "flatpak_installation_fetch_remote_ref_sync")]
fn fetch_remote_ref_sync(
&self,
remote_name: &str,
kind: RefKind,
name: &str,
arch: Option<&str>,
branch: Option<&str>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<RemoteRef, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_fetch_remote_ref_sync(
self.as_ref().to_glib_none().0,
remote_name.to_glib_none().0,
kind.into_glib(),
name.to_glib_none().0,
arch.to_glib_none().0,
branch.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Gets the current remote branch of a ref in the remote.
/// ## `remote_name`
/// the name of the remote
/// ## `kind`
/// what this ref contains (an [`RefKind`][crate::RefKind])
/// ## `name`
/// name of the app/runtime to fetch
/// ## `arch`
/// which architecture to fetch (default: current architecture)
/// ## `branch`
/// which branch to fetch (default: 'master')
/// ## `flags`
/// set of [`QueryFlags`][crate::QueryFlags]
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a [`RemoteRef`][crate::RemoteRef] instance, or [`None`]
#[cfg(feature = "v1_3_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3_3")))]
#[doc(alias = "flatpak_installation_fetch_remote_ref_sync_full")]
fn fetch_remote_ref_sync_full(
&self,
remote_name: &str,
kind: RefKind,
name: &str,
arch: Option<&str>,
branch: Option<&str>,
flags: QueryFlags,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<RemoteRef, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_fetch_remote_ref_sync_full(
self.as_ref().to_glib_none().0,
remote_name.to_glib_none().0,
kind.into_glib(),
name.to_glib_none().0,
arch.to_glib_none().0,
branch.to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Gets information about the maximum amount of data that needs to be transferred
/// to pull the ref from a remote repository, and about the amount of
/// local disk space that is required to check out this commit.
///
/// Note that if there are locally available data that are in the ref, which is common
/// for instance if you're doing an update then the real download size may be smaller
/// than what is returned here.
///
/// NOTE: Since 0.11.4 this information is accessible in FlatpakRemoteRef, so this
/// function is not very useful anymore.
/// ## `remote_name`
/// the name of the remote
/// ## `ref_`
/// the ref
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`], unless an error occurred
///
/// ## `download_size`
/// return location for the (maximum) download size
///
/// ## `installed_size`
/// return location for the installed size
#[doc(alias = "flatpak_installation_fetch_remote_size_sync")]
fn fetch_remote_size_sync(
&self,
remote_name: &str,
ref_: &impl IsA<Ref>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(u64, u64), glib::Error> {
unsafe {
let mut download_size = std::mem::MaybeUninit::uninit();
let mut installed_size = std::mem::MaybeUninit::uninit();
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_fetch_remote_size_sync(
self.as_ref().to_glib_none().0,
remote_name.to_glib_none().0,
ref_.as_ref().to_glib_none().0,
download_size.as_mut_ptr(),
installed_size.as_mut_ptr(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok((download_size.assume_init(), installed_size.assume_init()))
} else {
Err(from_glib_full(error))
}
}
}
/// Get a global configuration option for the installation, see
/// [`set_config_sync()`][Self::set_config_sync()] for supported keys.
/// ## `key`
/// the name of the key to get
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// The (newly allocated) value, or [`None`] on error (`G_KEY_FILE_ERROR_KEY_NOT_FOUND` error if key is not set)
#[doc(alias = "flatpak_installation_get_config")]
#[doc(alias = "get_config")]
fn config(
&self,
key: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<glib::GString, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_get_config(
self.as_ref().to_glib_none().0,
key.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Get the last build of reference `name` that was installed with
/// [`InstallationExtManual::install()`][crate::prelude::InstallationExtManual::install()], or [`None`] if the reference has
/// never been installed locally.
/// ## `name`
/// the name of the app
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// an [`InstalledRef`][crate::InstalledRef]
#[doc(alias = "flatpak_installation_get_current_installed_app")]
#[doc(alias = "get_current_installed_app")]
fn current_installed_app(
&self,
name: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<InstalledRef, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_get_current_installed_app(
self.as_ref().to_glib_none().0,
name.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Get the default languages used by the installation to decide which
/// subpaths to install of locale extensions. This list may also be used
/// by frontends like GNOME Software to decide which language-specific apps
/// to display. An empty array means that all languages should be installed.
///
/// # Returns
///
///
/// A possibly empty array of strings, or [`None`] on error.
#[cfg(feature = "v1_5")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_5")))]
#[doc(alias = "flatpak_installation_get_default_languages")]
#[doc(alias = "get_default_languages")]
fn default_languages(&self) -> Result<Vec<glib::GString>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_get_default_languages(
self.as_ref().to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Like [`default_languages()`][Self::default_languages()] but includes territory
/// information (e.g. `en_US` rather than `en`) which may be included in the
/// `extra-languages` configuration.
///
/// Strings returned by this function are in the format specified by
/// [``setlocale()``](man:setlocale): `language[_territory][.codeset][`modifier`]`.
///
/// # Returns
///
///
/// A possibly empty array of locale strings, or [`None`] on error.
#[cfg(feature = "v1_5_1")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_5_1")))]
#[doc(alias = "flatpak_installation_get_default_locales")]
#[doc(alias = "get_default_locales")]
fn default_locales(&self) -> Result<Vec<glib::GString>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_get_default_locales(
self.as_ref().to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Returns the display name of the installation for `self`.
///
/// Note that this function may return [`None`] if the installation
/// does not have a display name.
///
/// # Returns
///
/// a string with the installation's display name
#[doc(alias = "flatpak_installation_get_display_name")]
#[doc(alias = "get_display_name")]
fn display_name(&self) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::flatpak_installation_get_display_name(
self.as_ref().to_glib_none().0,
))
}
}
/// Returns the ID of the installation for `self`.
///
/// The ID for the default system installation is "default".
/// The ID for the user installation is "user".
///
/// # Returns
///
/// a string with the installation's ID
#[doc(alias = "flatpak_installation_get_id")]
#[doc(alias = "get_id")]
fn id(&self) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::flatpak_installation_get_id(
self.as_ref().to_glib_none().0,
))
}
}
#[doc(alias = "flatpak_installation_get_installed_ref")]
#[doc(alias = "get_installed_ref")]
fn installed_ref(
&self,
kind: RefKind,
name: &str,
arch: Option<&str>,
branch: Option<&str>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<InstalledRef, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_get_installed_ref(
self.as_ref().to_glib_none().0,
kind.into_glib(),
name.to_glib_none().0,
arch.to_glib_none().0,
branch.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Returns whether the installation is for a user-specific location.
///
/// # Returns
///
/// [`true`] if `self` is a per-user installation
#[doc(alias = "flatpak_installation_get_is_user")]
#[doc(alias = "get_is_user")]
fn is_user(&self) -> bool {
unsafe {
from_glib(ffi::flatpak_installation_get_is_user(
self.as_ref().to_glib_none().0,
))
}
}
/// Returns the min-free-space config value from the OSTree repository of this installation.
///
/// Applications can use this value, together with information about the available
/// disk space and the size of pending updates or installs, to estimate whether a
/// pull operation will fail due to running out of disk space.
///
/// # Returns
///
/// [`true`] on success, or [`false`] on error.
///
/// ## `out_bytes`
/// Location to store the result
#[cfg(feature = "v1_1")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_1")))]
#[doc(alias = "flatpak_installation_get_min_free_space_bytes")]
#[doc(alias = "get_min_free_space_bytes")]
fn min_free_space_bytes(&self) -> Result<u64, glib::Error> {
unsafe {
let mut out_bytes = std::mem::MaybeUninit::uninit();
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_get_min_free_space_bytes(
self.as_ref().to_glib_none().0,
out_bytes.as_mut_ptr(),
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(out_bytes.assume_init())
} else {
Err(from_glib_full(error))
}
}
}
/// Returns the value set with [`set_no_interaction()`][Self::set_no_interaction()].
///
/// # Returns
///
/// [`true`] if interactive authorization dialogs are not allowed
#[cfg(feature = "v1_1_1")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_1_1")))]
#[doc(alias = "flatpak_installation_get_no_interaction")]
#[doc(alias = "get_no_interaction")]
fn is_no_interaction(&self) -> bool {
unsafe {
from_glib(ffi::flatpak_installation_get_no_interaction(
self.as_ref().to_glib_none().0,
))
}
}
/// Returns the installation location for `self`.
///
/// # Returns
///
/// an [`gio::File`][crate::gio::File]
#[doc(alias = "flatpak_installation_get_path")]
#[doc(alias = "get_path")]
fn path(&self) -> Option<gio::File> {
unsafe {
from_glib_full(ffi::flatpak_installation_get_path(
self.as_ref().to_glib_none().0,
))
}
}
/// Returns the numeric priority of the installation for `self`.
///
/// # Returns
///
/// an integer with the configured priority value
#[doc(alias = "flatpak_installation_get_priority")]
#[doc(alias = "get_priority")]
fn priority(&self) -> i32 {
unsafe { ffi::flatpak_installation_get_priority(self.as_ref().to_glib_none().0) }
}
/// Looks up a remote by name.
/// ## `name`
/// a remote name
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a [`Remote`][crate::Remote] instance, or [`None`] with `error`
/// set
#[doc(alias = "flatpak_installation_get_remote_by_name")]
#[doc(alias = "get_remote_by_name")]
fn remote_by_name(
&self,
name: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Remote, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_get_remote_by_name(
self.as_ref().to_glib_none().0,
name.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Returns the type of storage of the installation for `self`.
///
/// # Returns
///
/// a [`StorageType`][crate::StorageType]
#[doc(alias = "flatpak_installation_get_storage_type")]
#[doc(alias = "get_storage_type")]
fn storage_type(&self) -> StorageType {
unsafe {
from_glib(ffi::flatpak_installation_get_storage_type(
self.as_ref().to_glib_none().0,
))
}
}
/// This is an old deprecated function, you should use
/// [`Transaction`][crate::Transaction] and [`TransactionExt::add_install_flatpakref()`][crate::prelude::TransactionExt::add_install_flatpakref()]
/// instead. It has a lot more interesting features.
///
/// Creates a remote based on the passed in .flatpakref file contents
/// in `ref_file_data` and returns the [`RemoteRef`][crate::RemoteRef] that can be used
/// to install it.
///
/// Note, the [`RemoteRef`][crate::RemoteRef] will not have the commit field set, or other details, to
/// avoid unnecessary roundtrips. If you need that you have to resolve it
/// explicitly with flatpak_installation_fetch_remote_ref_sync ().
///
/// # Deprecated since 1.7
///
/// Use [`TransactionExt::add_install_flatpakref()`][crate::prelude::TransactionExt::add_install_flatpakref()] instead.
/// ## `ref_file_data`
/// The ref file contents
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a [`RemoteRef`][crate::RemoteRef] if the remote has been added successfully, [`None`]
/// on error.
#[cfg_attr(feature = "v1_7", deprecated = "Since 1.7")]
#[allow(deprecated)]
#[doc(alias = "flatpak_installation_install_ref_file")]
fn install_ref_file(
&self,
ref_file_data: &glib::Bytes,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<RemoteRef, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_install_ref_file(
self.as_ref().to_glib_none().0,
ref_file_data.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Launch an installed application.
///
/// You can use `flatpak_installation_get_installed_ref()` or
/// [`current_installed_app()`][Self::current_installed_app()] to find out what builds
/// are available, in order to get a value for `commit`.
/// ## `name`
/// name of the app to launch
/// ## `arch`
/// which architecture to launch (default: current architecture)
/// ## `branch`
/// which branch of the application (default: "master")
/// ## `commit`
/// the commit of `branch` to launch
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`], unless an error occurred
#[doc(alias = "flatpak_installation_launch")]
fn launch(
&self,
name: &str,
arch: Option<&str>,
branch: Option<&str>,
commit: Option<&str>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_launch(
self.as_ref().to_glib_none().0,
name.to_glib_none().0,
arch.to_glib_none().0,
branch.to_glib_none().0,
commit.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Lists the installed references.
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`InstalledRef`][crate::InstalledRef] instances
#[doc(alias = "flatpak_installation_list_installed_refs")]
fn list_installed_refs(
&self,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<InstalledRef>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_installed_refs(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Lists the installed references of a specific kind.
/// ## `kind`
/// the kind of installation
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`InstalledRef`][crate::InstalledRef] instances
#[doc(alias = "flatpak_installation_list_installed_refs_by_kind")]
fn list_installed_refs_by_kind(
&self,
kind: RefKind,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<InstalledRef>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_installed_refs_by_kind(
self.as_ref().to_glib_none().0,
kind.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Lists the installed apps and runtimes that have an update available, either
/// from the configured remote or locally available but not deployed (see
/// [`TransactionExt::set_no_deploy()`][crate::prelude::TransactionExt::set_no_deploy()]).
///
/// This also checks if any of [`InstalledRef`][crate::InstalledRef] has a missing [`RelatedRef`][crate::RelatedRef]
/// (which has `should-download` set to [`true`]) or runtime. If so, it adds the
/// ref to the returning [`glib::PtrArray`][crate::glib::PtrArray] to pull in the [`RelatedRef`][crate::RelatedRef] or runtime
/// again via an update operation in [`Transaction`][crate::Transaction].
///
/// In case more than one app needs an update of the same runtime or extension,
/// this function will return all of those apps.
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`InstalledRef`][crate::InstalledRef] instances, or [`None`] on error
#[doc(alias = "flatpak_installation_list_installed_refs_for_update")]
fn list_installed_refs_for_update(
&self,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<InstalledRef>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_installed_refs_for_update(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Lists all the locally installed refs that are related to `ref_`. These are
/// things that are interesting to install, update, or uninstall together with
/// `ref_`. For instance, locale data or debug information.
///
/// Note that while the related refs are usually installed from the same remote
/// as `ref_` (`remote_name`), it is possible they were installed from another
/// remote.
///
/// This function is similar to flatpak_installation_list_remote_related_refs_sync,
/// but instead of looking at what is available on the remote, it only looks
/// at the locally installed refs. This is useful for instance when you're
/// looking for related refs to uninstall, or when you're planning to use
/// FLATPAK_UPDATE_FLAGS_NO_PULL to install previously pulled refs.
/// ## `remote_name`
/// the name of the remote providing `ref_`
/// ## `ref_`
/// the ref
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`RelatedRef`][crate::RelatedRef] instances
#[doc(alias = "flatpak_installation_list_installed_related_refs_sync")]
fn list_installed_related_refs_sync(
&self,
remote_name: &str,
ref_: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<RelatedRef>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_installed_related_refs_sync(
self.as_ref().to_glib_none().0,
remote_name.to_glib_none().0,
ref_.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Lists the installed references that are pinned, meaning they will not be
/// returned by [`list_unused_refs()`][Self::list_unused_refs()] and won't be removed
/// unless explicitly specified for removal.
///
/// Refs appear here either because they have been pinned automatically by
/// Flatpak or because the user pinned them; see flatpak-pin(1).
/// ## `arch`
/// if non-[`None`], the architecture of refs to collect
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`InstalledRef`][crate::InstalledRef] instances
#[cfg(feature = "v1_9_1")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_9_1")))]
#[doc(alias = "flatpak_installation_list_pinned_refs")]
fn list_pinned_refs(
&self,
arch: Option<&str>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<InstalledRef>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_pinned_refs(
self.as_ref().to_glib_none().0,
arch.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Lists all the applications and runtimes in a remote.
/// ## `remote_or_uri`
/// the name or URI of the remote
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`RemoteRef`][crate::RemoteRef] instances
#[doc(alias = "flatpak_installation_list_remote_refs_sync")]
fn list_remote_refs_sync(
&self,
remote_or_uri: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<RemoteRef>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_remote_refs_sync(
self.as_ref().to_glib_none().0,
remote_or_uri.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Lists all the applications and runtimes in a remote.
/// ## `remote_or_uri`
/// the name or URI of the remote
/// ## `flags`
/// set of [`QueryFlags`][crate::QueryFlags]
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`RemoteRef`][crate::RemoteRef] instances
#[cfg(feature = "v1_3_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_3_3")))]
#[doc(alias = "flatpak_installation_list_remote_refs_sync_full")]
fn list_remote_refs_sync_full(
&self,
remote_or_uri: &str,
flags: QueryFlags,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<RemoteRef>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_remote_refs_sync_full(
self.as_ref().to_glib_none().0,
remote_or_uri.to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Lists all the available refs on `remote_name` that are related to `ref_`, and
/// which are appropriate for the installed version of `ref_`. For example if the
/// installed version of org.videolan.VLC has a related ref of
/// org.videolan.VLC.Plugin.bdj//3-19.08 and the remote version of VLC has a
/// related ref of org.videolan.VLC.Plugin.bdj//3-20.08, this function will only
/// return the 3-19.08 branch.
///
/// See also the related functions
/// [`list_remote_related_refs_sync()`][Self::list_remote_related_refs_sync()] and
/// [`list_installed_related_refs_sync()`][Self::list_installed_related_refs_sync()].
///
/// The returned list contains all available related refs, but not
/// every one should always be installed. For example,
/// [`RelatedRefExt::should_download()`][crate::prelude::RelatedRefExt::should_download()] returns [`true`] if the
/// reference should be installed/updated with the app, and
/// [`RelatedRefExt::should_delete()`][crate::prelude::RelatedRefExt::should_delete()] returns [`true`] if it
/// should be uninstalled with the main ref.
///
/// The commit property of each [`RelatedRef`][crate::RelatedRef] is not guaranteed to be
/// non-[`None`].
/// ## `remote_name`
/// the name of the remote
/// ## `ref_`
/// the ref
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`RelatedRef`][crate::RelatedRef] instances
#[cfg(feature = "v1_11_1")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_11_1")))]
#[doc(alias = "flatpak_installation_list_remote_related_refs_for_installed_sync")]
fn list_remote_related_refs_for_installed_sync(
&self,
remote_name: &str,
ref_: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<RelatedRef>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_remote_related_refs_for_installed_sync(
self.as_ref().to_glib_none().0,
remote_name.to_glib_none().0,
ref_.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Lists all the available refs on `remote_name` that are related to
/// `ref_`, and the subpaths to use. These are things that are
/// interesting to install, update, or uninstall together with
/// `ref_`. For instance, locale data or debug information.
///
/// The returned list contains all available related refs, but not
/// every one should always be installed. For example,
/// [`RelatedRefExt::should_download()`][crate::prelude::RelatedRefExt::should_download()] returns [`true`] if the
/// reference should be installed/updated with the app, and
/// [`RelatedRefExt::should_delete()`][crate::prelude::RelatedRefExt::should_delete()] returns [`true`] if it
/// should be uninstalled with the main ref.
///
/// The commit property of each [`RelatedRef`][crate::RelatedRef] is not guaranteed to be
/// non-[`None`].
/// ## `remote_name`
/// the name of the remote
/// ## `ref_`
/// the ref
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`RelatedRef`][crate::RelatedRef] instances
#[doc(alias = "flatpak_installation_list_remote_related_refs_sync")]
fn list_remote_related_refs_sync(
&self,
remote_name: &str,
ref_: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<RelatedRef>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_remote_related_refs_sync(
self.as_ref().to_glib_none().0,
remote_name.to_glib_none().0,
ref_.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Lists the static remotes, in priority (highest first) order. For same
/// priority, an earlier added remote comes before a later added one.
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`Remote`][crate::Remote] instances
#[doc(alias = "flatpak_installation_list_remotes")]
fn list_remotes(
&self,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<Remote>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_remotes(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
//#[doc(alias = "flatpak_installation_list_remotes_by_type")]
//fn list_remotes_by_type(&self, types: /*Unimplemented*/&CArray TypeId { ns_id: 1, id: 17 }, cancellable: Option<&impl IsA<gio::Cancellable>>) -> Result<Vec<Remote>, glib::Error> {
// unsafe { TODO: call ffi:flatpak_installation_list_remotes_by_type() }
//}
/// Lists the installed references that are not 'used'.
///
/// A reference is used if it is either an application,
/// or the runtime or sdk of a used ref, or an extension of a used ref.
/// Pinned runtimes are also considered used; see flatpak-pin(1) and
/// [`list_pinned_refs()`][Self::list_pinned_refs()].
/// ## `arch`
/// if non-[`None`], the architecture of refs to collect
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// a GPtrArray of
/// [`InstalledRef`][crate::InstalledRef] instances
#[cfg(feature = "v1_1_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_1_2")))]
#[doc(alias = "flatpak_installation_list_unused_refs")]
fn list_unused_refs(
&self,
arch: Option<&str>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<InstalledRef>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_list_unused_refs(
self.as_ref().to_glib_none().0,
arch.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_container(ret))
} else {
Err(from_glib_full(error))
}
}
}
//#[cfg(feature = "v1_9_1")]
//#[cfg_attr(docsrs, doc(cfg(feature = "v1_9_1")))]
//#[doc(alias = "flatpak_installation_list_unused_refs_with_options")]
//fn list_unused_refs_with_options(&self, arch: Option<&str>, metadata_injection: /*Unknown conversion*//*Unimplemented*/HashTable TypeId { ns_id: 0, id: 25 }/TypeId { ns_id: 0, id: 25 }, options: Option<&glib::Variant>, cancellable: Option<&impl IsA<gio::Cancellable>>) -> Result<Vec<InstalledRef>, glib::Error> {
// unsafe { TODO: call ffi:flatpak_installation_list_unused_refs_with_options() }
//}
/// Loads the metadata overrides file for an application.
/// ## `app_id`
/// an application id
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// the contents of the overrides files,
/// or [`None`] if an error occurred
#[doc(alias = "flatpak_installation_load_app_overrides")]
fn load_app_overrides(
&self,
app_id: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<glib::GString, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::flatpak_installation_load_app_overrides(
self.as_ref().to_glib_none().0,
app_id.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Saves changes in the `remote` object.
/// ## `remote`
/// the modified [`Remote`][crate::Remote]
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`] if the modifications have been committed successfully
#[doc(alias = "flatpak_installation_modify_remote")]
fn modify_remote(
&self,
remote: &impl IsA<Remote>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_modify_remote(
self.as_ref().to_glib_none().0,
remote.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Remove all orphaned OSTree objects from the underlying OSTree repo in
/// `self`.
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`] on success
#[doc(alias = "flatpak_installation_prune_local_repo")]
fn prune_local_repo(
&self,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_prune_local_repo(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Remove the OSTree ref given by `remote_name`:`ref_` from the local flatpak
/// repository. The next time the underlying OSTree repo is pruned, objects
/// which were attached to that ref will be removed. This is useful if you
/// pulled a flatpak ref using [`InstallationExtManual::install_full()`][crate::prelude::InstallationExtManual::install_full()] and
/// specified [`InstallFlags::NO_DEPLOY`][crate::InstallFlags::NO_DEPLOY] but then decided not to
/// deploy the ref later on and want to remove the local ref to prevent it
/// from taking up disk space. Note that this will not remove the objects
/// referred to by `ref_` from the underlying OSTree repo, you should use
/// [`prune_local_repo()`][Self::prune_local_repo()] to do that.
/// ## `remote_name`
/// the name of the remote
/// ## `ref_`
/// the ref
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`] on success
#[doc(alias = "flatpak_installation_remove_local_ref_sync")]
fn remove_local_ref_sync(
&self,
remote_name: &str,
ref_: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_remove_local_ref_sync(
self.as_ref().to_glib_none().0,
remote_name.to_glib_none().0,
ref_.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Removes the remote with the given name from the installation.
/// ## `name`
/// the name of the remote to remove
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`] if the remote has been removed successfully
#[doc(alias = "flatpak_installation_remove_remote")]
fn remove_remote(
&self,
name: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_remove_remote(
self.as_ref().to_glib_none().0,
name.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Run the trigger commands to update the files exported by the apps in
/// `self`. Should be used after one or more app install, upgrade or
/// uninstall operations with the [`InstallFlags::NO_TRIGGERS`][crate::InstallFlags::NO_TRIGGERS],
/// [`UpdateFlags::NO_TRIGGERS`][crate::UpdateFlags::NO_TRIGGERS] or [`UninstallFlags::NO_TRIGGERS`][crate::UninstallFlags::NO_TRIGGERS]
/// flags set.
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`] on success
#[cfg(feature = "v1_0_3")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_0_3")))]
#[doc(alias = "flatpak_installation_run_triggers")]
fn run_triggers(
&self,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_run_triggers(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Set a global configuration option for the installation, currently
/// the only supported keys are `languages`, which is a semicolon-separated
/// list of language codes like `"sv;en;pl"`, or `""` to mean all languages,
/// and `extra-languages`, which is a semicolon-separated list of locale
/// identifiers like `"en;en_DK;zh_HK.big5hkscs;uz_UZ.utf8`cyrillic`"`.
/// ## `key`
/// the name of the key to set
/// ## `value`
/// the new value, or [`None`] to unset
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`] if the option was set correctly
#[doc(alias = "flatpak_installation_set_config_sync")]
fn set_config_sync(
&self,
key: &str,
value: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_set_config_sync(
self.as_ref().to_glib_none().0,
key.to_glib_none().0,
value.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// This method can be used to prevent interactive authorization dialogs to appear
/// for operations on `self`. This is useful for background operations that are not
/// directly triggered by a user action.
///
/// By default, interaction is allowed.
/// ## `no_interaction`
/// Whether to disallow interactive authorization for operations
#[cfg(feature = "v1_1_1")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_1_1")))]
#[doc(alias = "flatpak_installation_set_no_interaction")]
fn set_no_interaction(&self, no_interaction: bool) {
unsafe {
ffi::flatpak_installation_set_no_interaction(
self.as_ref().to_glib_none().0,
no_interaction.into_glib(),
);
}
}
/// Updates the local configuration of a remote repository by fetching
/// the related information from the summary file in the remote OSTree
/// repository and committing the changes to the local installation.
/// ## `name`
/// the name of the remote to update
/// ## `cancellable`
/// a [`gio::Cancellable`][crate::gio::Cancellable]
///
/// # Returns
///
/// [`true`] if the remote has been updated successfully
#[doc(alias = "flatpak_installation_update_remote_sync")]
fn update_remote_sync(
&self,
name: &str,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::flatpak_installation_update_remote_sync(
self.as_ref().to_glib_none().0,
name.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
}
impl<O: IsA<Installation>> InstallationExt for O {}