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
// // DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/nsIUnicharStreamLoader.idl // /// `interface nsIUnicharStreamLoaderObserver : 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 nsIUnicharStreamLoaderObserver { vtable: *const nsIUnicharStreamLoaderObserverVTable, /// 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 nsIUnicharStreamLoaderObserver. unsafe impl XpCom for nsIUnicharStreamLoaderObserver { const IID: nsIID = nsID(0xc2982b39, 0x2e48, 0x429e, [0x92, 0xb7, 0x99, 0x34, 0x8a, 0x16, 0x33, 0xc5]); } // 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 nsIUnicharStreamLoaderObserver { #[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 nsIUnicharStreamLoaderObserver. // 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 nsIUnicharStreamLoaderObserverCoerce { /// Cheaply cast a value of this type from a `nsIUnicharStreamLoaderObserver`. fn coerce_from(v: &nsIUnicharStreamLoaderObserver) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsIUnicharStreamLoaderObserverCoerce for nsIUnicharStreamLoaderObserver { #[inline] fn coerce_from(v: &nsIUnicharStreamLoaderObserver) -> &Self { v } } impl nsIUnicharStreamLoaderObserver { /// Cast this `nsIUnicharStreamLoaderObserver` to one of its base interfaces. #[inline] pub fn coerce<T: nsIUnicharStreamLoaderObserverCoerce>(&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 nsIUnicharStreamLoaderObserver { 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> nsIUnicharStreamLoaderObserverCoerce for T { #[inline] fn coerce_from(v: &nsIUnicharStreamLoaderObserver) -> &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 nsIUnicharStreamLoaderObserver // 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 nsIUnicharStreamLoaderObserverVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* ACString onDetermineCharset (in nsIUnicharStreamLoader aLoader, in nsISupports aContext, in ACString aSegment); */ pub OnDetermineCharset: unsafe extern "system" fn (this: *const nsIUnicharStreamLoaderObserver, aLoader: *const nsIUnicharStreamLoader, aContext: *const nsISupports, aSegment: &::nsstring::nsACString, _retval: &mut ::nsstring::nsACString) -> nsresult, /* void onStreamComplete (in nsIUnicharStreamLoader aLoader, in nsISupports aContext, in nsresult aStatus, in AString aBuffer); */ pub OnStreamComplete: unsafe extern "system" fn (this: *const nsIUnicharStreamLoaderObserver, aLoader: *const nsIUnicharStreamLoader, aContext: *const nsISupports, aStatus: nsresult, aBuffer: &::nsstring::nsAString) -> 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 nsIUnicharStreamLoaderObserver { /// ```text /// /** /// * Called as soon as at least 512 octets of data have arrived. /// * If the stream receives fewer than 512 octets of data in total, /// * called upon stream completion but before calling OnStreamComplete. /// * Will not be called if the stream receives no data at all. /// * /// * @param aLoader the unichar stream loader /// * @param aContext the context parameter of the underlying channel /// * @param aSegment up to 512 octets of raw data from the stream /// * /// * @return the name of the character set to be used to decode this stream /// */ /// ``` /// /// `ACString onDetermineCharset (in nsIUnicharStreamLoader aLoader, in nsISupports aContext, in ACString aSegment);` #[inline] pub unsafe fn OnDetermineCharset(&self, aLoader: *const nsIUnicharStreamLoader, aContext: *const nsISupports, aSegment: &::nsstring::nsACString, _retval: &mut ::nsstring::nsACString) -> nsresult { ((*self.vtable).OnDetermineCharset)(self, aLoader, aContext, aSegment, _retval) } /// ```text /// /** /// * Called when the entire stream has been loaded and decoded. /// * /// * @param aLoader the unichar stream loader /// * @param aContext the context parameter of the underlying channel /// * @param aStatus the status of the underlying channel /// * @param aBuffer the contents of the stream, decoded to UTF-16. /// * /// * This method will always be called asynchronously by the /// * nsUnicharIStreamLoader involved, on the thread that called the /// * loader's init() method. If onDetermineCharset fails, /// * onStreamComplete will still be called, but aStatus will be an /// * error code. /// */ /// ``` /// /// `void onStreamComplete (in nsIUnicharStreamLoader aLoader, in nsISupports aContext, in nsresult aStatus, in AString aBuffer);` #[inline] pub unsafe fn OnStreamComplete(&self, aLoader: *const nsIUnicharStreamLoader, aContext: *const nsISupports, aStatus: nsresult, aBuffer: &::nsstring::nsAString) -> nsresult { ((*self.vtable).OnStreamComplete)(self, aLoader, aContext, aStatus, aBuffer) } } /// `interface nsIUnicharStreamLoader : nsIStreamListener` /// // 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 nsIUnicharStreamLoader { vtable: *const nsIUnicharStreamLoaderVTable, /// 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 nsIUnicharStreamLoader. unsafe impl XpCom for nsIUnicharStreamLoader { const IID: nsIID = nsID(0xafb62060, 0x37c7, 0x4713, [0x8a, 0x84, 0x4a, 0x0c, 0x11, 0x99, 0xba, 0x5c]); } // 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 nsIUnicharStreamLoader { #[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 nsIUnicharStreamLoader. // 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 nsIUnicharStreamLoaderCoerce { /// Cheaply cast a value of this type from a `nsIUnicharStreamLoader`. fn coerce_from(v: &nsIUnicharStreamLoader) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsIUnicharStreamLoaderCoerce for nsIUnicharStreamLoader { #[inline] fn coerce_from(v: &nsIUnicharStreamLoader) -> &Self { v } } impl nsIUnicharStreamLoader { /// Cast this `nsIUnicharStreamLoader` to one of its base interfaces. #[inline] pub fn coerce<T: nsIUnicharStreamLoaderCoerce>(&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 nsIUnicharStreamLoader { type Target = nsIStreamListener; #[inline] fn deref(&self) -> &nsIStreamListener { 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: nsIStreamListenerCoerce> nsIUnicharStreamLoaderCoerce for T { #[inline] fn coerce_from(v: &nsIUnicharStreamLoader) -> &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 nsIUnicharStreamLoader // 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 nsIUnicharStreamLoaderVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsIStreamListenerVTable, /* void init (in nsIUnicharStreamLoaderObserver aObserver); */ pub Init: unsafe extern "system" fn (this: *const nsIUnicharStreamLoader, aObserver: *const nsIUnicharStreamLoaderObserver) -> nsresult, /* readonly attribute nsIChannel channel; */ pub GetChannel: unsafe extern "system" fn (this: *const nsIUnicharStreamLoader, aChannel: *mut *const nsIChannel) -> nsresult, /* readonly attribute ACString charset; */ pub GetCharset: unsafe extern "system" fn (this: *const nsIUnicharStreamLoader, aCharset: &mut ::nsstring::nsACString) -> nsresult, /* readonly attribute ACString rawBuffer; */ pub GetRawBuffer: unsafe extern "system" fn (this: *const nsIUnicharStreamLoader, aRawBuffer: &mut ::nsstring::nsACString) -> 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 nsIUnicharStreamLoader { /// ```text /// /** /// * Asynchronously load a channel, converting the data to UTF-16. /// * /// * To use this interface, first call init() with a /// * nsIUnicharStreamLoaderObserver that will be notified when the data has been /// * loaded. Then call asyncOpen() on the channel with the nsIUnicharStreamLoader /// * as the listener. The context argument in the asyncOpen() call will be /// * passed to the onStreamComplete() callback. /// */ /// /** /// * Initializes the unichar stream loader /// * /// * @param aObserver the observer to notify when a charset is needed and when /// * the load is complete /// */ /// ``` /// /// `void init (in nsIUnicharStreamLoaderObserver aObserver);` #[inline] pub unsafe fn Init(&self, aObserver: *const nsIUnicharStreamLoaderObserver) -> nsresult { ((*self.vtable).Init)(self, aObserver) } /// ```text /// /** /// * The channel attribute is only valid inside the onDetermineCharset /// * and onStreamComplete callbacks. Otherwise it will be null. /// */ /// ``` /// /// `readonly attribute nsIChannel channel;` #[inline] pub unsafe fn GetChannel(&self, aChannel: *mut *const nsIChannel) -> nsresult { ((*self.vtable).GetChannel)(self, aChannel) } /// ```text /// /** /// * The charset that onDetermineCharset returned, if that's been /// * called. /// */ /// ``` /// /// `readonly attribute ACString charset;` #[inline] pub unsafe fn GetCharset(&self, aCharset: &mut ::nsstring::nsACString) -> nsresult { ((*self.vtable).GetCharset)(self, aCharset) } /// ```text /// /** /// * Get the raw bytes as seen on the wire prior to character converstion. /// * Used by Subresource Integrity checker to generate the correct hash. /// */ /// ``` /// /// `readonly attribute ACString rawBuffer;` #[inline] pub unsafe fn GetRawBuffer(&self, aRawBuffer: &mut ::nsstring::nsACString) -> nsresult { ((*self.vtable).GetRawBuffer)(self, aRawBuffer) } }