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
// // DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/nsICacheStorageService.idl // /// `interface nsICacheStorageService : nsISupports` /// /// ```text /// /** /// * Provides access to particual cache storages of the network URI cache. /// */ /// ``` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsICacheStorageService { vtable: *const nsICacheStorageServiceVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsICacheStorageService. unsafe impl XpCom for nsICacheStorageService { const IID: nsIID = nsID(0xae29c44b, 0xfbc3, 0x4552, [0xaf, 0xaf, 0x0a, 0x15, 0x7c, 0xe7, 0x71, 0xe7]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsICacheStorageService { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsICacheStorageService. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsICacheStorageServiceCoerce { /// Cheaply cast a value of this type from a `nsICacheStorageService`. fn coerce_from(v: &nsICacheStorageService) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsICacheStorageServiceCoerce for nsICacheStorageService { #[inline] fn coerce_from(v: &nsICacheStorageService) -> &Self { v } } impl nsICacheStorageService { /// Cast this `nsICacheStorageService` to one of its base interfaces. #[inline] pub fn coerce<T: nsICacheStorageServiceCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsICacheStorageService { type Target = nsISupports; #[inline] fn deref(&self) -> &nsISupports { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsISupportsCoerce> nsICacheStorageServiceCoerce for T { #[inline] fn coerce_from(v: &nsICacheStorageService) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsICacheStorageService // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsICacheStorageServiceVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* nsICacheStorage memoryCacheStorage (in nsILoadContextInfo aLoadContextInfo); */ pub MemoryCacheStorage: unsafe extern "system" fn (this: *const nsICacheStorageService, aLoadContextInfo: *const nsILoadContextInfo, _retval: *mut *const nsICacheStorage) -> nsresult, /* nsICacheStorage diskCacheStorage (in nsILoadContextInfo aLoadContextInfo, in bool aLookupAppCache); */ pub DiskCacheStorage: unsafe extern "system" fn (this: *const nsICacheStorageService, aLoadContextInfo: *const nsILoadContextInfo, aLookupAppCache: bool, _retval: *mut *const nsICacheStorage) -> nsresult, /* nsICacheStorage pinningCacheStorage (in nsILoadContextInfo aLoadContextInfo); */ pub PinningCacheStorage: unsafe extern "system" fn (this: *const nsICacheStorageService, aLoadContextInfo: *const nsILoadContextInfo, _retval: *mut *const nsICacheStorage) -> nsresult, /* nsICacheStorage appCacheStorage (in nsILoadContextInfo aLoadContextInfo, in nsIApplicationCache aApplicationCache); */ pub AppCacheStorage: unsafe extern "system" fn (this: *const nsICacheStorageService, aLoadContextInfo: *const nsILoadContextInfo, aApplicationCache: *const nsIApplicationCache, _retval: *mut *const nsICacheStorage) -> nsresult, /* nsICacheStorage synthesizedCacheStorage (in nsILoadContextInfo aLoadContextInfo); */ pub SynthesizedCacheStorage: unsafe extern "system" fn (this: *const nsICacheStorageService, aLoadContextInfo: *const nsILoadContextInfo, _retval: *mut *const nsICacheStorage) -> nsresult, /* void clear (); */ pub Clear: unsafe extern "system" fn (this: *const nsICacheStorageService) -> nsresult, /* void purgeFromMemory (in uint32_t aWhat); */ pub PurgeFromMemory: unsafe extern "system" fn (this: *const nsICacheStorageService, aWhat: uint32_t) -> nsresult, /* readonly attribute nsIEventTarget ioTarget; */ pub GetIoTarget: unsafe extern "system" fn (this: *const nsICacheStorageService, aIoTarget: *mut *const nsIEventTarget) -> nsresult, /* void asyncGetDiskConsumption (in nsICacheStorageConsumptionObserver aObserver); */ pub AsyncGetDiskConsumption: unsafe extern "system" fn (this: *const nsICacheStorageService, aObserver: *const nsICacheStorageConsumptionObserver) -> nsresult, /* void asyncVisitAllStorages (in nsICacheStorageVisitor aVisitor, in boolean aVisitEntries); */ pub AsyncVisitAllStorages: unsafe extern "system" fn (this: *const nsICacheStorageService, aVisitor: *const nsICacheStorageVisitor, aVisitEntries: bool) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsICacheStorageService { /// ```text /// /** /// * Purge only data of disk backed entries. Metadata are left for /// * performance purposes. /// */ /// ``` /// pub const PURGE_DISK_DATA_ONLY: i64 = 1; /// ```text /// /** /// * Purge whole disk backed entries from memory. Disk files will /// * be left unattended. /// */ /// ``` /// pub const PURGE_DISK_ALL: i64 = 2; /// ```text /// /** /// * Purge all entries we keep in memory, including memory-storage /// * entries. This may be dangerous to use. /// */ /// ``` /// pub const PURGE_EVERYTHING: i64 = 3; /// ```text /// /** /// * Get storage where entries will only remain in memory, never written /// * to the disk. /// * /// * NOTE: Any existing disk entry for [URL|id-extension] will be doomed /// * prior opening an entry using this memory-only storage. Result of /// * AsyncOpenURI will be a new and empty memory-only entry. Using /// * OPEN_READONLY open flag has no effect on this behavior. /// * /// * @param aLoadContextInfo /// * Information about the loading context, this focuses the storage JAR and /// * respects separate storage for private browsing. /// */ /// ``` /// /// `nsICacheStorage memoryCacheStorage (in nsILoadContextInfo aLoadContextInfo);` #[inline] pub unsafe fn MemoryCacheStorage(&self, aLoadContextInfo: *const nsILoadContextInfo, _retval: *mut *const nsICacheStorage) -> nsresult { ((*self.vtable).MemoryCacheStorage)(self, aLoadContextInfo, _retval) } /// ```text /// /** /// * Get storage where entries will be written to disk when not forbidden by /// * response headers. /// * /// * @param aLookupAppCache /// * When set true (for top level document loading channels) app cache will /// * be first to check on to find entries in. /// */ /// ``` /// /// `nsICacheStorage diskCacheStorage (in nsILoadContextInfo aLoadContextInfo, in bool aLookupAppCache);` #[inline] pub unsafe fn DiskCacheStorage(&self, aLoadContextInfo: *const nsILoadContextInfo, aLookupAppCache: bool, _retval: *mut *const nsICacheStorage) -> nsresult { ((*self.vtable).DiskCacheStorage)(self, aLoadContextInfo, aLookupAppCache, _retval) } /// ```text /// /** /// * Get storage where entries will be written to disk and marked as pinned. /// * These pinned entries are immune to over limit eviction and call of clear() /// * on this service. /// */ /// ``` /// /// `nsICacheStorage pinningCacheStorage (in nsILoadContextInfo aLoadContextInfo);` #[inline] pub unsafe fn PinningCacheStorage(&self, aLoadContextInfo: *const nsILoadContextInfo, _retval: *mut *const nsICacheStorage) -> nsresult { ((*self.vtable).PinningCacheStorage)(self, aLoadContextInfo, _retval) } /// ```text /// /** /// * Get storage for a specified application cache obtained using some different /// * mechanism. /// * /// * @param aLoadContextInfo /// * Mandatory reference to a load context information. /// * @param aApplicationCache /// * Optional reference to an existing appcache. When left null, this will /// * work with offline cache as a whole. /// */ /// ``` /// /// `nsICacheStorage appCacheStorage (in nsILoadContextInfo aLoadContextInfo, in nsIApplicationCache aApplicationCache);` #[inline] pub unsafe fn AppCacheStorage(&self, aLoadContextInfo: *const nsILoadContextInfo, aApplicationCache: *const nsIApplicationCache, _retval: *mut *const nsICacheStorage) -> nsresult { ((*self.vtable).AppCacheStorage)(self, aLoadContextInfo, aApplicationCache, _retval) } /// ```text /// /** /// * Get storage for synthesized cache entries that we currently use for ServiceWorker interception in non-e10s mode. /// * /// * This cache storage has no limits on file size to allow the ServiceWorker to intercept large files. /// */ /// ``` /// /// `nsICacheStorage synthesizedCacheStorage (in nsILoadContextInfo aLoadContextInfo);` #[inline] pub unsafe fn SynthesizedCacheStorage(&self, aLoadContextInfo: *const nsILoadContextInfo, _retval: *mut *const nsICacheStorage) -> nsresult { ((*self.vtable).SynthesizedCacheStorage)(self, aLoadContextInfo, _retval) } /// ```text /// /** /// * Evict the whole cache. /// */ /// ``` /// /// `void clear ();` #[inline] pub unsafe fn Clear(&self, ) -> nsresult { ((*self.vtable).Clear)(self, ) } /// ```text /// /** /// * Purges data we keep warmed in memory. Use for tests and for /// * saving memory. /// */ /// ``` /// /// `void purgeFromMemory (in uint32_t aWhat);` #[inline] pub unsafe fn PurgeFromMemory(&self, aWhat: uint32_t) -> nsresult { ((*self.vtable).PurgeFromMemory)(self, aWhat) } /// ```text /// /** /// * I/O thread target to use for any operations on disk /// */ /// ``` /// /// `readonly attribute nsIEventTarget ioTarget;` #[inline] pub unsafe fn GetIoTarget(&self, aIoTarget: *mut *const nsIEventTarget) -> nsresult { ((*self.vtable).GetIoTarget)(self, aIoTarget) } /// ```text /// /** /// * Asynchronously determine how many bytes of the disk space the cache takes. /// * @see nsICacheStorageConsumptionObserver /// * @param aObserver /// * A mandatory (weak referred) observer. Documented at /// * nsICacheStorageConsumptionObserver. /// * NOTE: the observer MUST implement nsISupportsWeakReference. /// */ /// ``` /// /// `void asyncGetDiskConsumption (in nsICacheStorageConsumptionObserver aObserver);` #[inline] pub unsafe fn AsyncGetDiskConsumption(&self, aObserver: *const nsICacheStorageConsumptionObserver) -> nsresult { ((*self.vtable).AsyncGetDiskConsumption)(self, aObserver) } /// ```text /// /** /// * Asynchronously visits all storages of the disk cache and memory cache. /// * @see nsICacheStorageVisitor /// * @param aVisitor /// * A visitor callback. /// * @param aVisitEntries /// * A boolean indicates whether visits entries. /// */ /// ``` /// /// `void asyncVisitAllStorages (in nsICacheStorageVisitor aVisitor, in boolean aVisitEntries);` #[inline] pub unsafe fn AsyncVisitAllStorages(&self, aVisitor: *const nsICacheStorageVisitor, aVisitEntries: bool) -> nsresult { ((*self.vtable).AsyncVisitAllStorages)(self, aVisitor, aVisitEntries) } } /// `interface nsICacheStorageConsumptionObserver : nsISupports` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsICacheStorageConsumptionObserver { vtable: *const nsICacheStorageConsumptionObserverVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsICacheStorageConsumptionObserver. unsafe impl XpCom for nsICacheStorageConsumptionObserver { const IID: nsIID = nsID(0x7728ab5b, 0x4c01, 0x4483, [0xa6, 0x06, 0x32, 0xbf, 0x5b, 0x81, 0x36, 0xcb]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsICacheStorageConsumptionObserver { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsICacheStorageConsumptionObserver. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsICacheStorageConsumptionObserverCoerce { /// Cheaply cast a value of this type from a `nsICacheStorageConsumptionObserver`. fn coerce_from(v: &nsICacheStorageConsumptionObserver) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsICacheStorageConsumptionObserverCoerce for nsICacheStorageConsumptionObserver { #[inline] fn coerce_from(v: &nsICacheStorageConsumptionObserver) -> &Self { v } } impl nsICacheStorageConsumptionObserver { /// Cast this `nsICacheStorageConsumptionObserver` to one of its base interfaces. #[inline] pub fn coerce<T: nsICacheStorageConsumptionObserverCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsICacheStorageConsumptionObserver { type Target = nsISupports; #[inline] fn deref(&self) -> &nsISupports { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsISupportsCoerce> nsICacheStorageConsumptionObserverCoerce for T { #[inline] fn coerce_from(v: &nsICacheStorageConsumptionObserver) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsICacheStorageConsumptionObserver // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsICacheStorageConsumptionObserverVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* void onNetworkCacheDiskConsumption (in int64_t aDiskSize); */ pub OnNetworkCacheDiskConsumption: unsafe extern "system" fn (this: *const nsICacheStorageConsumptionObserver, aDiskSize: int64_t) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsICacheStorageConsumptionObserver { /// ```text /// /** /// * Callback invoked to answer asyncGetDiskConsumption call. Always triggered /// * on the main thread. /// * NOTE: implementers must also implement nsISupportsWeakReference. /// * /// * @param aDiskSize /// * The disk consumption in bytes. /// */ /// ``` /// /// `void onNetworkCacheDiskConsumption (in int64_t aDiskSize);` #[inline] pub unsafe fn OnNetworkCacheDiskConsumption(&self, aDiskSize: int64_t) -> nsresult { ((*self.vtable).OnNetworkCacheDiskConsumption)(self, aDiskSize) } }