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
// // DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/mozIStorageStatement.idl // /// `interface mozIStorageStatement : mozIStorageBaseStatement` /// /// ```text /// /** /// * A SQL statement that can be used for both synchronous and asynchronous /// * purposes. /// */ /// ``` /// // 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 mozIStorageStatement { vtable: *const mozIStorageStatementVTable, /// 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 mozIStorageStatement. unsafe impl XpCom for mozIStorageStatement { const IID: nsIID = nsID(0x5f567c35, 0x6c32, 0x4140, [0x82, 0x8c, 0x68, 0x3e, 0xa4, 0x9c, 0xfd, 0x3a]); } // 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 mozIStorageStatement { #[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 mozIStorageStatement. // 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 mozIStorageStatementCoerce { /// Cheaply cast a value of this type from a `mozIStorageStatement`. fn coerce_from(v: &mozIStorageStatement) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl mozIStorageStatementCoerce for mozIStorageStatement { #[inline] fn coerce_from(v: &mozIStorageStatement) -> &Self { v } } impl mozIStorageStatement { /// Cast this `mozIStorageStatement` to one of its base interfaces. #[inline] pub fn coerce<T: mozIStorageStatementCoerce>(&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 mozIStorageStatement { type Target = mozIStorageBaseStatement; #[inline] fn deref(&self) -> &mozIStorageBaseStatement { 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: mozIStorageBaseStatementCoerce> mozIStorageStatementCoerce for T { #[inline] fn coerce_from(v: &mozIStorageStatement) -> &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 mozIStorageStatement // 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 mozIStorageStatementVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: mozIStorageBaseStatementVTable, /* mozIStorageStatement clone (); */ pub Clone: unsafe extern "system" fn (this: *const mozIStorageStatement, _retval: *mut *const mozIStorageStatement) -> nsresult, /* readonly attribute unsigned long parameterCount; */ pub GetParameterCount: unsafe extern "system" fn (this: *const mozIStorageStatement, aParameterCount: *mut libc::uint32_t) -> nsresult, /* AUTF8String getParameterName (in unsigned long aParamIndex); */ pub GetParameterName: unsafe extern "system" fn (this: *const mozIStorageStatement, aParamIndex: libc::uint32_t, _retval: &mut ::nsstring::nsACString) -> nsresult, /* unsigned long getParameterIndex (in AUTF8String aName); */ pub GetParameterIndex: unsafe extern "system" fn (this: *const mozIStorageStatement, aName: &::nsstring::nsACString, _retval: *mut libc::uint32_t) -> nsresult, /* readonly attribute unsigned long columnCount; */ pub GetColumnCount: unsafe extern "system" fn (this: *const mozIStorageStatement, aColumnCount: *mut libc::uint32_t) -> nsresult, /* AUTF8String getColumnName (in unsigned long aColumnIndex); */ pub GetColumnName: unsafe extern "system" fn (this: *const mozIStorageStatement, aColumnIndex: libc::uint32_t, _retval: &mut ::nsstring::nsACString) -> nsresult, /* unsigned long getColumnIndex (in AUTF8String aName); */ pub GetColumnIndex: unsafe extern "system" fn (this: *const mozIStorageStatement, aName: &::nsstring::nsACString, _retval: *mut libc::uint32_t) -> nsresult, /* void reset (); */ pub Reset: unsafe extern "system" fn (this: *const mozIStorageStatement) -> nsresult, /* void execute (); */ pub Execute: unsafe extern "system" fn (this: *const mozIStorageStatement) -> nsresult, /* boolean executeStep (); */ pub ExecuteStep: unsafe extern "system" fn (this: *const mozIStorageStatement, _retval: *mut bool) -> nsresult, /* readonly attribute unsigned long numEntries; */ pub GetNumEntries: unsafe extern "system" fn (this: *const mozIStorageStatement, aNumEntries: *mut libc::uint32_t) -> nsresult, /* long getTypeOfIndex (in unsigned long aIndex); */ pub GetTypeOfIndex: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, _retval: *mut libc::int32_t) -> nsresult, /* long getInt32 (in unsigned long aIndex); */ pub GetInt32: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, _retval: *mut libc::int32_t) -> nsresult, /* long long getInt64 (in unsigned long aIndex); */ pub GetInt64: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, _retval: *mut libc::int64_t) -> nsresult, /* double getDouble (in unsigned long aIndex); */ pub GetDouble: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, _retval: *mut libc::c_double) -> nsresult, /* AUTF8String getUTF8String (in unsigned long aIndex); */ pub GetUTF8String: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, _retval: &mut ::nsstring::nsACString) -> nsresult, /* AString getString (in unsigned long aIndex); */ pub GetString: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, _retval: &mut ::nsstring::nsAString) -> nsresult, /* void getBlob (in unsigned long aIndex, out unsigned long aDataSize, [array, size_is (aDataSize)] out octet aData); */ pub GetBlob: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, aDataSize: *mut libc::uint32_t, aData: *mut *mut libc::uint8_t) -> nsresult, /* AString getBlobAsString (in unsigned long aIndex); */ pub GetBlobAsString: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, _retval: &mut ::nsstring::nsAString) -> nsresult, /* AUTF8String getBlobAsUTF8String (in unsigned long aIndex); */ pub GetBlobAsUTF8String: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, _retval: &mut ::nsstring::nsACString) -> nsresult, /* boolean getIsNull (in unsigned long aIndex); */ pub GetIsNull: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, _retval: *mut bool) -> nsresult, /* [noscript] void getSharedUTF8String (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out string aResult); */ pub GetSharedUTF8String: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, aLength: *mut libc::uint32_t, aResult: *mut *const libc::c_char) -> nsresult, /* [noscript] void getSharedString (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out wstring aResult); */ pub GetSharedString: unsafe extern "system" fn (this: *const mozIStorageStatement, aIndex: libc::uint32_t, aLength: *mut libc::uint32_t, aResult: *mut *const libc::int16_t) -> nsresult, /* [noscript] void getSharedBlob (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out octetPtr aResult); */ /// Unable to generate binding because `native type uint8_t is unsupported` pub GetSharedBlob: *const ::libc::c_void, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl mozIStorageStatement { /// ```text /// /** /// * Execute a query, using any currently-bound parameters. Reset is called /// * when no more data is returned. This method is only available to JavaScript /// * consumers. /// * /// * @deprecated As of Mozilla 1.9.2 in favor of executeStep(). /// * /// * @return a boolean indicating whether there are more rows or not. /// * /// * [deprecated] boolean step(); /// */ /// /** /// * Obtains the current list of named parameters, which are settable. This /// * property is only available to JavaScript consumers. /// * /// * readonly attribute mozIStorageStatementParams params; /// */ /// /** /// * Obtains the current row, with access to all the data members by name. This /// * property is only available to JavaScript consumers. /// * /// * readonly attribute mozIStorageStatementRow row; /// */ /// /** /// * These type values are returned by getTypeOfIndex /// * to indicate what type of value is present at /// * a given column. /// */ /// ``` /// pub const VALUE_TYPE_NULL: i64 = 0; pub const VALUE_TYPE_INTEGER: i64 = 1; pub const VALUE_TYPE_FLOAT: i64 = 2; pub const VALUE_TYPE_TEXT: i64 = 3; pub const VALUE_TYPE_BLOB: i64 = 4; /// ```text /// /** /// * Create a clone of this statement, by initializing a new statement /// * with the same connection and same SQL statement as this one. It /// * does not preserve statement state; that is, if a statement is /// * being executed when it is cloned, the new statement will not be /// * executing. /// */ /// ``` /// /// `mozIStorageStatement clone ();` #[inline] pub unsafe fn Clone(&self, _retval: *mut *const mozIStorageStatement) -> nsresult { ((*self.vtable).Clone)(self, _retval) } /// `readonly attribute unsigned long parameterCount;` #[inline] pub unsafe fn GetParameterCount(&self, aParameterCount: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetParameterCount)(self, aParameterCount) } /// ```text /// /** /// * Name of nth parameter, if given /// */ /// ``` /// /// `AUTF8String getParameterName (in unsigned long aParamIndex);` #[inline] pub unsafe fn GetParameterName(&self, aParamIndex: libc::uint32_t, _retval: &mut ::nsstring::nsACString) -> nsresult { ((*self.vtable).GetParameterName)(self, aParamIndex, _retval) } /// ```text /// /** /// * Returns the index of the named parameter. /// * /// * @param aName /// * The name of the parameter you want the index for. This does not /// * include the leading ':'. /// * @return the index of the named parameter. /// */ /// ``` /// /// `unsigned long getParameterIndex (in AUTF8String aName);` #[inline] pub unsafe fn GetParameterIndex(&self, aName: &::nsstring::nsACString, _retval: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetParameterIndex)(self, aName, _retval) } /// ```text /// /** /// * Number of columns returned /// */ /// ``` /// /// `readonly attribute unsigned long columnCount;` #[inline] pub unsafe fn GetColumnCount(&self, aColumnCount: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetColumnCount)(self, aColumnCount) } /// ```text /// /** /// * Name of nth column /// */ /// ``` /// /// `AUTF8String getColumnName (in unsigned long aColumnIndex);` #[inline] pub unsafe fn GetColumnName(&self, aColumnIndex: libc::uint32_t, _retval: &mut ::nsstring::nsACString) -> nsresult { ((*self.vtable).GetColumnName)(self, aColumnIndex, _retval) } /// ```text /// /** /// * Obtains the index of the column with the specified name. /// * /// * @param aName /// * The name of the column. /// * @return The index of the column with the specified name. /// */ /// ``` /// /// `unsigned long getColumnIndex (in AUTF8String aName);` #[inline] pub unsafe fn GetColumnIndex(&self, aName: &::nsstring::nsACString, _retval: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetColumnIndex)(self, aName, _retval) } /// ```text /// /** /// * Reset parameters/statement execution /// */ /// ``` /// /// `void reset ();` #[inline] pub unsafe fn Reset(&self, ) -> nsresult { ((*self.vtable).Reset)(self, ) } /// ```text /// /** /// * Execute the query, ignoring any results. This is accomplished by /// * calling executeStep() once, and then calling reset(). /// * /// * Error and last insert info, etc. are available from /// * the mozStorageConnection. /// */ /// ``` /// /// `void execute ();` #[inline] pub unsafe fn Execute(&self, ) -> nsresult { ((*self.vtable).Execute)(self, ) } /// ```text /// /** /// * Execute a query, using any currently-bound parameters. Reset /// * must be called on the statement after the last call of /// * executeStep. /// * /// * @return a boolean indicating whether there are more rows or not; /// * row data may be accessed using mozIStorageValueArray methods on /// * the statement. /// */ /// ``` /// /// `boolean executeStep ();` #[inline] pub unsafe fn ExecuteStep(&self, _retval: *mut bool) -> nsresult { ((*self.vtable).ExecuteStep)(self, _retval) } /// ```text /// /** /// * The number of entries in the array (each corresponding to a column in the /// * database row) /// */ /// ``` /// /// `readonly attribute unsigned long numEntries;` #[inline] pub unsafe fn GetNumEntries(&self, aNumEntries: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetNumEntries)(self, aNumEntries) } /// ```text /// /** /// * Indicate the data type of the current result row for the the given column. /// * SQLite will perform type conversion if you ask for a value as a different /// * type than it is stored as. /// * /// * @param aIndex /// * 0-based column index. /// * @return The type of the value at the given column index; one of /// * VALUE_TYPE_NULL, VALUE_TYPE_INTEGER, VALUE_TYPE_FLOAT, /// * VALUE_TYPE_TEXT, VALUE_TYPE_BLOB. /// */ /// ``` /// /// `long getTypeOfIndex (in unsigned long aIndex);` #[inline] pub unsafe fn GetTypeOfIndex(&self, aIndex: libc::uint32_t, _retval: *mut libc::int32_t) -> nsresult { ((*self.vtable).GetTypeOfIndex)(self, aIndex, _retval) } /// ```text /// /** /// * Retrieve the contents of a column from the current result row as an /// * integer. /// * /// * @param aIndex /// * 0-based colummn index. /// * @return Column value interpreted as an integer per type conversion rules. /// * @{ /// */ /// ``` /// /// `long getInt32 (in unsigned long aIndex);` #[inline] pub unsafe fn GetInt32(&self, aIndex: libc::uint32_t, _retval: *mut libc::int32_t) -> nsresult { ((*self.vtable).GetInt32)(self, aIndex, _retval) } /// `long long getInt64 (in unsigned long aIndex);` #[inline] pub unsafe fn GetInt64(&self, aIndex: libc::uint32_t, _retval: *mut libc::int64_t) -> nsresult { ((*self.vtable).GetInt64)(self, aIndex, _retval) } /// ```text /// /** @} */ /// /** /// * Retrieve the contents of a column from the current result row as a /// * floating point double. /// * /// * @param aIndex /// * 0-based colummn index. /// * @return Column value interpreted as a double per type conversion rules. /// */ /// ``` /// /// `double getDouble (in unsigned long aIndex);` #[inline] pub unsafe fn GetDouble(&self, aIndex: libc::uint32_t, _retval: *mut libc::c_double) -> nsresult { ((*self.vtable).GetDouble)(self, aIndex, _retval) } /// ```text /// /** /// * Retrieve the contents of a column from the current result row as a /// * string. /// * /// * @param aIndex /// * 0-based colummn index. /// * @return The value for the result column interpreted as a string. If the /// * stored value was NULL, you will get an empty string with IsVoid set /// * to distinguish it from an explicitly set empty string. /// * @{ /// */ /// ``` /// /// `AUTF8String getUTF8String (in unsigned long aIndex);` #[inline] pub unsafe fn GetUTF8String(&self, aIndex: libc::uint32_t, _retval: &mut ::nsstring::nsACString) -> nsresult { ((*self.vtable).GetUTF8String)(self, aIndex, _retval) } /// `AString getString (in unsigned long aIndex);` #[inline] pub unsafe fn GetString(&self, aIndex: libc::uint32_t, _retval: &mut ::nsstring::nsAString) -> nsresult { ((*self.vtable).GetString)(self, aIndex, _retval) } /// ```text /// /** @} */ /// /** /// * Retrieve the contents of a column from the current result row as a /// * blob. /// * /// * @param aIndex /// * 0-based colummn index. /// * @param[out] aDataSize /// * The number of bytes in the blob. /// * @param[out] aData /// * The contents of the BLOB. This will be NULL if aDataSize == 0. /// */ /// ``` /// /// `void getBlob (in unsigned long aIndex, out unsigned long aDataSize, [array, size_is (aDataSize)] out octet aData);` #[inline] pub unsafe fn GetBlob(&self, aIndex: libc::uint32_t, aDataSize: *mut libc::uint32_t, aData: *mut *mut libc::uint8_t) -> nsresult { ((*self.vtable).GetBlob)(self, aIndex, aDataSize, aData) } /// ```text /// /** /// * Retrieve the contents of a Blob column from the current result row as a /// * string. /// * /// * @param aIndex /// * 0-based colummn index. /// * @return The value for the result Blob column interpreted as a String. /// * No encoding conversion is performed. /// */ /// ``` /// /// `AString getBlobAsString (in unsigned long aIndex);` #[inline] pub unsafe fn GetBlobAsString(&self, aIndex: libc::uint32_t, _retval: &mut ::nsstring::nsAString) -> nsresult { ((*self.vtable).GetBlobAsString)(self, aIndex, _retval) } /// ```text /// /** /// * Retrieve the contents of a Blob column from the current result row as a /// * UTF8 string. /// * /// * @param aIndex /// * 0-based colummn index. /// * @return The value for the result Blob column interpreted as a UTF8 String. /// * No encoding conversion is performed. /// */ /// ``` /// /// `AUTF8String getBlobAsUTF8String (in unsigned long aIndex);` #[inline] pub unsafe fn GetBlobAsUTF8String(&self, aIndex: libc::uint32_t, _retval: &mut ::nsstring::nsACString) -> nsresult { ((*self.vtable).GetBlobAsUTF8String)(self, aIndex, _retval) } /// ```text /// /** /// * Check whether the given column in the current result row is NULL. /// * /// * @param aIndex /// * 0-based colummn index. /// * @return true if the value for the result column is null. /// */ /// ``` /// /// `boolean getIsNull (in unsigned long aIndex);` #[inline] pub unsafe fn GetIsNull(&self, aIndex: libc::uint32_t, _retval: *mut bool) -> nsresult { ((*self.vtable).GetIsNull)(self, aIndex, _retval) } /// ```text /// /** /// * Returns a shared string pointer /// */ /// ``` /// /// `[noscript] void getSharedUTF8String (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out string aResult);` #[inline] pub unsafe fn GetSharedUTF8String(&self, aIndex: libc::uint32_t, aLength: *mut libc::uint32_t, aResult: *mut *const libc::c_char) -> nsresult { ((*self.vtable).GetSharedUTF8String)(self, aIndex, aLength, aResult) } /// `[noscript] void getSharedString (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out wstring aResult);` #[inline] pub unsafe fn GetSharedString(&self, aIndex: libc::uint32_t, aLength: *mut libc::uint32_t, aResult: *mut *const libc::int16_t) -> nsresult { ((*self.vtable).GetSharedString)(self, aIndex, aLength, aResult) } /// `[noscript] void getSharedBlob (in unsigned long aIndex, out unsigned long aLength, [shared, retval] out octetPtr aResult);` const _GetSharedBlob: () = (); }