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
/* * This file was generated by rust-bindgen from a minified version * of /usr/include/tarantool.h and then edited manually. */ /* {{{ Logging */ #[repr(u32)] /** Log levels */ #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] pub enum SayLevel { Fatal = 0, System = 1, Error = 2, Crit = 3, Warn = 4, Info = 5, Debug = 6, } extern "C" { #[link_name = "log_level"] pub static mut log_level: ::std::os::raw::c_int; pub fn say_log_level_is_enabled(level: ::std::os::raw::c_int) -> bool; } pub type SayFunc = ::core::option::Option<unsafe extern "C" fn(arg1: ::std::os::raw::c_int, arg2: *const ::std::os::raw::c_char, arg3: ::std::os::raw::c_int, arg4: *const ::std::os::raw::c_char, arg5: *const ::std::os::raw::c_char, ...)>; extern "C" { #[link_name = "_say"] pub static mut _say: SayFunc; } /* }}} Logging */ /* {{{ Fiber */ #[repr(C)] #[derive(Debug, Copy)] pub struct fiber { pub _address: u8, } impl Clone for fiber { fn clone(&self) -> Self { *self } } /* TODO: remove valist */ #[repr(C)] #[derive(Debug, Copy)] pub struct BuiltinVaListTag { pub gp_offset: ::std::os::raw::c_uint, pub fp_offset: ::std::os::raw::c_uint, pub overflow_arg_area: *mut ::std::os::raw::c_void, pub reg_save_area: *mut ::std::os::raw::c_void, } impl Clone for BuiltinVaListTag { fn clone(&self) -> Self { *self } } pub type BuiltinVaList = [BuiltinVaListTag; 1usize]; /** * Fiber - contains information about fiber */ pub type FiberFunc = ::core::option::Option<unsafe extern "C" fn(arg1: *mut BuiltinVaListTag) -> ::std::os::raw::c_int>; extern "C" { /** * Create a new fiber. * * Takes a fiber from fiber cache, if it's not empty. * Can fail only if there is not enough memory for * the fiber structure or fiber stack. * * The created fiber automatically returns itself * to the fiber cache when its "main" function * completes. * * \param name string with fiber name * \param FiberFunc func for run inside fiber * * \sa fiber_start */ pub fn fiber_new(name: *const ::std::os::raw::c_char, f: FiberFunc) -> *mut fiber; /** * Return control to another fiber and wait until it'll be woken. * * \sa fiber_wakeup */ pub fn fiber_yield(); /** * Start execution of created fiber. * * \param callee fiber to start * \param ... arguments to start the fiber with * * \sa fiber_new */ pub fn fiber_start(callee: *mut fiber, ...); /** * Interrupt a synchronous wait of a fiber * * \param f fiber to be woken up */ pub fn fiber_wakeup(f: *mut fiber); /** * Cancel the subject fiber. (set FIBER_IS_CANCELLED flag) * * If target fiber's flag FIBER_IS_CANCELLABLE set, then it would * be woken up (maybe prematurely). Then current fiber yields * until the target fiber is dead (or is woken up by * \sa fiber_wakeup). * * \param f fiber to be cancelled */ pub fn fiber_cancel(f: *mut fiber); /** * Make it possible or not possible to wakeup the current * fiber immediately when it's cancelled. * * @param yesno status to set * @return previous state. */ pub fn fiber_set_cancellable(yesno: bool) -> bool; /** * Set fiber to be joinable (false by default). * \param yesno status to set */ pub fn fiber_set_joinable(fiber: *mut fiber, yesno: bool); /** * Wait until the fiber is dead and then move its execution * status to the caller. * The fiber must not be detached (@sa fiber_set_joinable()). * @pre FIBER_IS_JOINABLE flag is set. * * \param f fiber to be woken up * \return fiber function ret code */ pub fn fiber_join(f: *mut fiber) -> ::std::os::raw::c_int; /** * Put the current fiber to sleep for at least 's' seconds. * * \param s time to sleep * * \note this is a cancellation point (\sa fiber_is_cancelled) */ pub fn fiber_sleep(s: f64); /** * Check current fiber for cancellation (it must be checked * manually). */ pub fn fiber_is_cancelled() -> bool; /** * Report loop begin time as double (cheap). */ pub fn fiber_time() -> f64; /** * Report loop begin time as 64-bit int. */ pub fn fiber_time64() -> u64; /** * Reschedule fiber to end of event loop cycle. */ pub fn fiber_reschedule(); } /** * Return slab_cache suitable to use with tarantool/small library */ #[repr(C)] #[derive(Debug, Copy)] pub struct slab_cache { pub _address: u8, } impl Clone for slab_cache { fn clone(&self) -> Self { *self } } extern "C" { pub fn cord_slab_cache() -> *mut slab_cache; } #[repr(u32)] #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] pub enum CoioFlags { Read = 1, Write = 2, } extern "C" { /** * Wait until READ or WRITE event on socket (\a fd). Yields. * \param fd - non-blocking socket file description * \param events - requested events to wait. * Combination of TNT_IO_READ | TNT_IO_WRITE bit flags. * \param timeoout - timeout in seconds. * \retval 0 - timeout * \retval >0 - returned events. Combination of TNT_IO_READ | TNT_IO_WRITE * bit flags. */ pub fn coio_wait(fd: ::std::os::raw::c_int, event: ::std::os::raw::c_int, timeout: f64) -> ::std::os::raw::c_int; /** * Close the fd and wake any fiber blocked in * coio_wait() call on this fd. */ pub fn coio_close(fd: ::std::os::raw::c_int) -> ::std::os::raw::c_int; /** * Create new eio task with specified function and * arguments. Yield and wait until the task is complete * or a timeout occurs. * * This function doesn't throw exceptions to avoid double error * checking: in most cases it's also necessary to check the return * value of the called function and perform necessary actions. If * func sets errno, the errno is preserved across the call. * * @retval -1 and errno = ENOMEM if failed to create a task * @retval the function return (errno is preserved). * * @code * static ssize_t openfile_cb(va_list ap) * { * const char *filename = va_arg(ap); * int flags = va_arg(ap); * return open(filename, flags); * } * * if (coio_call(openfile_cb, 0.10, "/tmp/file", 0) == -1) * // handle errors. * ... * @endcode */ pub fn coio_call(func: ::core::option::Option<unsafe extern "C" fn(arg1: *mut BuiltinVaListTag) -> ::std::os::raw::c_int>, ...) -> isize; } #[repr(C)] #[derive(Debug, Copy)] pub struct addrinfo { pub _address: u8, } impl Clone for addrinfo { fn clone(&self) -> Self { *self } } extern "C" { /** * Fiber-friendly version of getaddrinfo(3). * * @param host host name, i.e. "tarantool.org" * @param port service name, i.e. "80" or "http" * @param hints hints, see getaddrinfo(3) * @param res[out] result, see getaddrinfo(3) * @param timeout timeout * @retval 0 on success, please free @a res using freeaddrinfo(3). * @retval -1 on error, check diag. * Please note that the return value is not compatible with * getaddrinfo(3). * @sa getaddrinfo() */ pub fn coio_getaddrinfo(host: *const ::std::os::raw::c_char, port: *const ::std::os::raw::c_char, hints: *const addrinfo, res: *mut *mut addrinfo, timeout: f64) -> ::std::os::raw::c_int; } /* }}} Fiber */ /* {{{ Transaction */ extern "C" { /** * Return true if there is an active transaction. */ pub fn box_txn() -> bool; /** * Begin a transaction in the current fiber. * * A transaction is attached to caller fiber, therefore one fiber can have * only one active transaction. * * @retval 0 - success * @retval -1 - failed, perhaps a transaction has already been * started */ pub fn box_txn_begin() -> ::std::os::raw::c_int; /** * Commit the current transaction. * @retval 0 - success * @retval -1 - failed, perhaps a disk write failure. * started */ pub fn box_txn_commit() -> ::std::os::raw::c_int; /** * Rollback the current transaction. * May fail if called from a nested * statement. */ pub fn box_txn_rollback() -> ::std::os::raw::c_int; /** * Allocate memory on txn memory pool. * The memory is automatically deallocated when the transaction * is committed or rolled back. * * @retval NULL out of memory */ pub fn box_txn_alloc(size: usize) -> *mut ::std::os::raw::c_void; } /* }}} Transaction */ /* {{{ Tuple */ #[repr(C)] #[derive(Debug, Copy)] pub struct tuple_format { pub _address: u8, } impl Clone for tuple_format { fn clone(&self) -> Self { *self } } pub type BoxTupleFormat = tuple_format; extern "C" { /** * Tuple Format. * * Each Tuple has associated format (class). Default format is used to * create tuples which are not attach to any particular space. */ pub fn box_tuple_format_default() -> *mut BoxTupleFormat; } #[repr(C)] #[derive(Debug, Copy)] pub struct tuple { pub _address: u8, } impl Clone for tuple { fn clone(&self) -> Self { *self } } /** * Tuple */ pub type BoxTuple = tuple; extern "C" { /** * Allocate and initialize a new tuple from a raw MsgPack Array data. * * \param format tuple format. * Use box_tuple_format_default() to create space-independent tuple. * \param data tuple data in MsgPack Array format ([field1, field2, ...]). * \param end the end of \a data * \retval NULL on out of memory * \retval tuple otherwise * \pre data, end is valid MsgPack Array * \sa \code box.tuple.new(data) \endcode */ pub fn box_tuple_new(format: *mut BoxTupleFormat, data: *const ::std::os::raw::c_char, end: *const ::std::os::raw::c_char) -> *mut BoxTuple; /** * Increase the reference counter of tuple. * * Tuples are reference counted. All functions that return tuples guarantee * that the last returned tuple is refcounted internally until the next * call to API function that yields or returns another tuple. * * You should increase the reference counter before taking tuples for long * processing in your code. Such tuples will not be garbage collected even * if another fiber remove they from space. After processing please * decrement the reference counter using box_tuple_unref(), otherwise the * tuple will leak. * * \param tuple a tuple * \retval -1 on error (check box_error_last()) * \retval 0 on success * \sa box_tuple_unref() */ pub fn box_tuple_ref(tuple: *mut BoxTuple) -> ::std::os::raw::c_int; /** * Decrease the reference counter of tuple. * * \param tuple a tuple * \sa box_tuple_ref() */ pub fn box_tuple_unref(tuple: *mut BoxTuple); /** * Return the number of fields in tuple (the size of MsgPack Array). * \param tuple a tuple */ pub fn box_tuple_field_count(tuple: *const BoxTuple) -> u32; /** * Return the number of bytes used to store internal tuple data (MsgPack Array). * \param tuple a tuple */ pub fn box_tuple_bsize(tuple: *const BoxTuple) -> usize; /** * Dump raw MsgPack data to the memory byffer \a buf of size \a size. * * Store tuple fields in the memory buffer. * \retval -1 on error. * \retval number of bytes written on success. * Upon successful return, the function returns the number of bytes written. * If buffer size is not enough then the return value is the number of bytes * which would have been written if enough space had been available. */ pub fn BoxTupleo_buf(tuple: *const BoxTuple, buf: *mut ::std::os::raw::c_char, size: usize) -> isize; /** * Return the associated format. * \param tuple tuple * \return tuple_format */ pub fn box_tuple_format(tuple: *const BoxTuple) -> *mut BoxTupleFormat; /** * Return the raw tuple field in MsgPack format. * * The buffer is valid until next call to box_tuple_* functions. * * \param tuple a tuple * \param fieldno zero-based index in MsgPack array. * \retval NULL if i >= box_tuple_field_count(tuple) * \retval msgpack otherwise */ pub fn box_tuple_field(tuple: *const BoxTuple, fieldno: u32) -> *const ::std::os::raw::c_char; } #[repr(C)] #[derive(Debug, Copy)] pub struct tuple_iterator { pub _address: u8, } impl Clone for tuple_iterator { fn clone(&self) -> Self { *self } } /** * Tuple iterator */ pub type BoxTupleIterator = tuple_iterator; extern "C" { /** * Allocate and initialize a new tuple iterator. The tuple iterator * allow to iterate over fields at root level of MsgPack array. * * Example: * \code * box_tuple_iterator *it = box_tuple_iterator(tuple); * if (it == NULL) { * // error handling using box_error_last() * } * const char *field; * while (field = box_tuple_next(it)) { * // process raw MsgPack data * } * * // rewind iterator to first position * box_tuple_rewind(it); * assert(box_tuple_position(it) == 0); * * // rewind iterator to first position * field = box_tuple_seek(it, 3); * assert(box_tuple_position(it) == 4); * * box_iterator_free(it); * \endcode * * \post box_tuple_position(it) == 0 */ pub fn box_tuple_iterator(tuple: *mut BoxTuple) -> *mut BoxTupleIterator; /** * Destroy and free tuple iterator */ pub fn box_tuple_iterator_free(it: *mut BoxTupleIterator); /** * Return zero-based next position in iterator. * That is, this function return the field id of field that will be * returned by the next call to box_tuple_next(it). Returned value is zero * after initialization or rewind and box_tuple_field_count(tuple) * after the end of iteration. * * \param it tuple iterator * \returns position. */ pub fn box_tuple_position(it: *mut BoxTupleIterator) -> u32; /** * Rewind iterator to the initial position. * * \param it tuple iterator * \post box_tuple_position(it) == 0 */ pub fn box_tuple_rewind(it: *mut BoxTupleIterator); /** * Seek the tuple iterator. * * The returned buffer is valid until next call to box_tuple_* API. * Requested fieldno returned by next call to box_tuple_next(it). * * \param it tuple iterator * \param fieldno - zero-based position in MsgPack array. * \post box_tuple_position(it) == fieldno if returned value is not NULL * \post box_tuple_position(it) == box_tuple_field_count(tuple) if returned * value is NULL. */ pub fn box_tuple_seek(it: *mut BoxTupleIterator, fieldno: u32) -> *const ::std::os::raw::c_char; /** * Return the next tuple field from tuple iterator. * The returned buffer is valid until next call to box_tuple_* API. * * \param it tuple iterator. * \retval NULL if there are no more fields. * \retval MsgPack otherwise * \pre box_tuple_position(it) is zerod-based id of returned field * \post box_tuple_position(it) == box_tuple_field_count(tuple) if returned * value is NULL. */ pub fn box_tuple_next(it: *mut BoxTupleIterator) -> *const ::std::os::raw::c_char; pub fn box_tuple_update(tuple: *const BoxTuple, expr: *const ::std::os::raw::c_char, expr_end: *const ::std::os::raw::c_char) -> *mut BoxTuple; pub fn box_tuple_upsert(tuple: *const BoxTuple, expr: *const ::std::os::raw::c_char, expr_end: *const ::std::os::raw::c_char) -> *mut BoxTuple; pub fn box_tuple_extract_key(tuple: *const BoxTuple, space_id: u32, index_id: u32, key_size: *mut u32) -> *mut ::std::os::raw::c_char; } /* }}} Tuple */ /* {{{ Space */ pub const BOX_SYSTEM_ID_MIN: u32 = 256; pub const BOX_SCHEMA_ID: u32 = 272; pub const BOX_SPACE_ID: u32 = 280; pub const BOX_VSPACE_ID: u32 = 281; pub const BOX_INDEX_ID: u32 = 288; pub const BOX_VINDEX_ID: u32 = 289; pub const BOX_FUNC_ID: u32 = 296; pub const BOX_VFUNC_ID: u32 = 297; pub const BOX_USER_ID: u32 = 304; pub const BOX_VUSER_ID: u32 = 305; pub const BOX_PRIV_ID: u32 = 312; pub const BOX_VPRIV_ID: u32 = 313; pub const BOX_CLUSTER_ID: u32 = 320; pub const BOX_SYSTEM_ID_MAX: u32 = 511; pub const BOX_ID_NIL: u32 = 2147483647; #[repr(C)] #[derive(Debug, Copy)] pub struct box_function_ctx { pub _address: u8, } impl Clone for box_function_ctx { fn clone(&self) -> Self { *self } } pub type BoxFunctionCtx = box_function_ctx; extern "C" { /** * Return a tuple from stored C procedure. * * Returned tuple is automatically reference counted by Tarantool. * * \param ctx an opaque structure passed to the stored C procedure by * Tarantool * \param tuple a tuple to return * \retval -1 on error (perhaps, out of memory; check box_error_last()) * \retval 0 otherwise */ pub fn box_return_tuple(ctx: *mut BoxFunctionCtx, tuple: *mut BoxTuple) -> ::std::os::raw::c_int; /** * Find space id by name. * * This function performs SELECT request to _vspace system space. * \param name space name * \param len length of \a name * \retval BOX_ID_NIL on error or if not found (check box_error_last()) * \retval space_id otherwise * \sa box_index_id_by_name */ pub fn box_space_id_by_name(name: *const ::std::os::raw::c_char, len: u32) -> u32; /** * Find index id by name. * * This function performs SELECT request to _vindex system space. * \param space_id space identifier * \param name index name * \param len length of \a name * \retval BOX_ID_NIL on error or if not found (check box_error_last()) * \retval index_id otherwise * \sa box_space_id_by_name */ pub fn box_index_id_by_name(space_id: u32, name: *const ::std::os::raw::c_char, len: u32) -> u32; /** * Execute an INSERT request. * * \param space_id space identifier * \param tuple encoded tuple in MsgPack Array format ([ field1, field2, ...]) * \param tuple_end end of @a tuple * \param[out] result a new tuple. Can be set to NULL to discard result. * \retval -1 on error (check box_error_last()) * \retval 0 on success * \sa \code box.space[space_id]:insert(tuple) \endcode */ pub fn box_insert(space_id: u32, tuple: *const ::std::os::raw::c_char, tuple_end: *const ::std::os::raw::c_char, result: *mut *mut BoxTuple) -> ::std::os::raw::c_int; /** * Execute an REPLACE request. * * \param space_id space identifier * \param tuple encoded tuple in MsgPack Array format ([ field1, field2, ...]) * \param tuple_end end of @a tuple * \param[out] result a new tuple. Can be set to NULL to discard result. * \retval -1 on error (check box_error_last()) * \retval 0 on success * \sa \code box.space[space_id]:replace(tuple) \endcode */ pub fn box_replace(space_id: u32, tuple: *const ::std::os::raw::c_char, tuple_end: *const ::std::os::raw::c_char, result: *mut *mut BoxTuple) -> ::std::os::raw::c_int; /** * Execute an DELETE request. * * \param space_id space identifier * \param index_id index identifier * \param key encoded key in MsgPack Array format ([part1, part2, ...]). * \param key_end the end of encoded \a key. * \param[out] result an old tuple. Can be set to NULL to discard result. * \retval -1 on error (check box_error_last()) * \retval 0 on success * \sa \code box.space[space_id].index[index_id]:delete(key) \endcode */ pub fn box_delete(space_id: u32, index_id: u32, key: *const ::std::os::raw::c_char, key_end: *const ::std::os::raw::c_char, result: *mut *mut BoxTuple) -> ::std::os::raw::c_int; /** * Execute an UPDATE request. * * \param space_id space identifier * \param index_id index identifier * \param key encoded key in MsgPack Array format ([part1, part2, ...]). * \param key_end the end of encoded \a key. * \param ops encoded operations in MsgPack Arrat format, e.g. * [ [ '=', fieldno, value ], ['!', 2, 'xxx'] ] * \param ops_end the end of encoded \a ops * \param index_base 0 if fieldnos in update operations are zero-based * indexed (like C) or 1 if for one-based indexed field ids (like Lua). * \param[out] result a new tuple. Can be set to NULL to discard result. * \retval -1 on error (check box_error_last()) * \retval 0 on success * \sa \code box.space[space_id].index[index_id]:update(key, ops) \endcode * \sa box_upsert() */ pub fn box_update(space_id: u32, index_id: u32, key: *const ::std::os::raw::c_char, key_end: *const ::std::os::raw::c_char, ops: *const ::std::os::raw::c_char, ops_end: *const ::std::os::raw::c_char, index_base: ::std::os::raw::c_int, result: *mut *mut BoxTuple) -> ::std::os::raw::c_int; /** * Execute an UPSERT request. * * \param space_id space identifier * \param index_id index identifier * \param ops encoded operations in MsgPack Arrat format, e.g. * [ [ '=', fieldno, value ], ['!', 2, 'xxx'] ] * \param ops_end the end of encoded \a ops * \param tuple encoded tuple in MsgPack Array format ([ field1, field2, ...]) * \param tuple_end end of @a tuple * \param index_base 0 if fieldnos in update operations are zero-based * indexed (like C) or 1 if for one-based indexed field ids (like Lua). * \param[out] result a new tuple. Can be set to NULL to discard result. * \retval -1 on error (check box_error_last()) * \retval 0 on success * \sa \code box.space[space_id].index[index_id]:update(key, ops) \endcode * \sa box_update() */ pub fn box_upsert(space_id: u32, index_id: u32, tuple: *const ::std::os::raw::c_char, tuple_end: *const ::std::os::raw::c_char, ops: *const ::std::os::raw::c_char, ops_end: *const ::std::os::raw::c_char, index_base: ::std::os::raw::c_int, result: *mut *mut BoxTuple) -> ::std::os::raw::c_int; /** * Truncate space. * * \param space_id space identifier */ pub fn box_truncate(space_id: u32) -> ::std::os::raw::c_int; } /* }}} Space */ /* {{{ Index */ #[repr(C)] #[derive(Debug, Copy)] pub struct iterator { pub _address: u8, } impl Clone for iterator { fn clone(&self) -> Self { *self } } /** A space iterator */ pub type BoxIterator = iterator; #[repr(u32)] /** * Controls how to iterate over tuples in an index. * Different index types support different iterator types. * For example, one can start iteration from a particular value * (request key) and then retrieve all tuples where keys are * greater or equal (= GE) to this key. * * If iterator type is not supported by the selected index type, * iterator constructor must fail with ER_UNSUPPORTED. To be * selectable for primary key, an index must support at least * ITER_EQ and ITER_GE types. * * NULL value of request key corresponds to the first or last * key in the index, depending on iteration direction. * (first key for GE and GT types, and last key for LE and LT). * Therefore, to iterate over all tuples in an index, one can * use ITER_GE or ITER_LE iteration types with start key equal * to NULL. * For ITER_EQ, the key must not be NULL. */ #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] pub enum IteratorType { EQ = 0, REQ = 1, ALL = 2, LT = 3, LE = 4, GE = 5, GT = 6, BitsAllSet = 7, BitsAnySet = 8, BitsAllNotSet = 9, Ovelaps = 10, Neigbor = 11, } extern "C" { /** * Allocate and initialize iterator for space_id, index_id. * * A returned iterator must be destroyed by box_iterator_free(). * * \param space_id space identifier. * \param index_id index identifier. * \param type \link iterator_type iterator type \endlink * \param key encoded key in MsgPack Array format ([part1, part2, ...]). * \param key_end the end of encoded \a key * \retval NULL on error (check box_error_last()) * \retval iterator otherwise * \sa box_iterator_next() * \sa box_iterator_free() */ pub fn box_index_iterator(space_id: u32, index_id: u32, type_: ::std::os::raw::c_int, key: *const ::std::os::raw::c_char, key_end: *const ::std::os::raw::c_char) -> *mut BoxIterator; /** * Retrive the next item from the \a iterator. * * \param iterator an iterator returned by box_index_iterator(). * \param[out] result a tuple or NULL if there is no more data. * \retval -1 on error (check box_error_last() for details) * \retval 0 on success. The end of data is not an error. */ pub fn box_iterator_next(iterator: *mut BoxIterator, result: *mut *mut BoxTuple) -> ::std::os::raw::c_int; /** * Destroy and deallocate iterator. * * \param iterator an interator returned by box_index_iterator() */ pub fn box_iterator_free(iterator: *mut BoxIterator); /** * Return the number of element in the index. * * \param space_id space identifier * \param index_id index identifier * \retval -1 on error (check box_error_last()) * \retval >= 0 otherwise */ pub fn box_index_len(space_id: u32, index_id: u32) -> isize; /** * Return the number of bytes used in memory by the index. * * \param space_id space identifier * \param index_id index identifier * \retval -1 on error (check box_error_last()) * \retval >= 0 otherwise */ pub fn box_index_bsize(space_id: u32, index_id: u32) -> isize; /** * Return a random tuple from the index (useful for statistical analysis). * * \param space_id space identifier * \param index_id index identifier * \param rnd random seed * \param[out] result a tuple or NULL if index is empty * \retval -1 on error (check box_error_last()) * \retval 0 on success * \sa \code box.space[space_id].index[index_id]:random(rnd) \endcode */ pub fn box_index_random(space_id: u32, index_id: u32, rnd: u32, result: *mut *mut BoxTuple) -> ::std::os::raw::c_int; /** * Get a tuple from index by the key. * * Please note that this function works much more faster than * box_select() or box_index_iterator() + box_iterator_next(). * * \param space_id space identifier * \param index_id index identifier * \param key encoded key in MsgPack Array format ([part1, part2, ...]). * \param key_end the end of encoded \a key * \param[out] result a tuple or NULL if index is empty * \retval -1 on error (check box_error_last()) * \retval 0 on success * \pre key != NULL * \sa \code box.space[space_id].index[index_id]:get(key) \endcode */ pub fn box_index_get(space_id: u32, index_id: u32, key: *const ::std::os::raw::c_char, key_end: *const ::std::os::raw::c_char, result: *mut *mut BoxTuple) -> ::std::os::raw::c_int; /** * Return a first (minimal) tuple matched the provided key. * * \param space_id space identifier * \param index_id index identifier * \param key encoded key in MsgPack Array format ([part1, part2, ...]). * \param key_end the end of encoded \a key. * \param[out] result a tuple or NULL if index is empty * \retval -1 on error (check box_error_last()) * \retval 0 on success * \sa \code box.space[space_id].index[index_id]:min(key) \endcode */ pub fn box_index_min(space_id: u32, index_id: u32, key: *const ::std::os::raw::c_char, key_end: *const ::std::os::raw::c_char, result: *mut *mut BoxTuple) -> ::std::os::raw::c_int; /** * Return a last (maximal) tuple matched the provided key. * * \param space_id space identifier * \param index_id index identifier * \param key encoded key in MsgPack Array format ([part1, part2, ...]). * \param key_end the end of encoded \a key. * \param[out] result a tuple or NULL if index is empty * \retval -1 on error (check box_error_last()) * \retval 0 on success * \sa \code box.space[space_id].index[index_id]:max(key) \endcode */ pub fn box_index_max(space_id: u32, index_id: u32, key: *const ::std::os::raw::c_char, key_end: *const ::std::os::raw::c_char, result: *mut *mut BoxTuple) -> ::std::os::raw::c_int; /** * Count the number of tuple matched the provided key. * * \param space_id space identifier * \param index_id index identifier * \param type iterator type - enum \link iterator_type \endlink * \param key encoded key in MsgPack Array format ([part1, part2, ...]). * \param key_end the end of encoded \a key. * \retval -1 on error (check box_error_last()) * \retval >=0 on success * \sa \code box.space[space_id].index[index_id]:count(key, * { iterator = type }) \endcode */ pub fn box_index_count(space_id: u32, index_id: u32, type_: ::std::os::raw::c_int, key: *const ::std::os::raw::c_char, key_end: *const ::std::os::raw::c_char) -> isize; } /* }}} Index */ /* {{{ Error */ #[repr(C)] #[derive(Debug, Copy)] pub struct error { pub _address: u8, } impl Clone for error { fn clone(&self) -> Self { *self } } /** * Error - contains information about error. */ pub type BoxError = error; extern "C" { /** * Return the error type, e.g. "ClientError", "SocketError", etc. * \param error * \return not-null string */ pub fn BoxErrorype(error: *const BoxError) -> *const ::std::os::raw::c_char; /** * Return IPROTO error code * \param error error * \return enum box_error_code */ pub fn box_error_code(error: *const BoxError) -> u32; /** * Return the error message * \param error error * \return not-null string */ pub fn box_error_message(error: *const BoxError) -> *const ::std::os::raw::c_char; /** * Get the information about the last API call error. * * The Tarantool error handling works most like libc's errno. All API calls * return -1 or NULL in the event of error. An internal pointer to * BoxError type is set by API functions to indicate what went wrong. * This value is only significant if API call failed (returned -1 or NULL). * * Successful function can also touch the last error in some * cases. You don't have to clear the last error before calling * API functions. The returned object is valid only until next * call to **any** API function. * * You must set the last error using box_error_set() in your stored C * procedures if you want to return a custom error message. * You can re-throw the last API error to IPROTO client by keeping * the current value and returning -1 to Tarantool from your * stored procedure. * * \return last error. */ pub fn box_error_last() -> *mut BoxError; /** * Clear the last error. */ pub fn box_error_clear(); /** * Set the last error. * * \param code IPROTO error code (enum \link box_error_code \endlink) * \param format (const char * ) - printf()-like format string * \param ... - format arguments * \returns -1 for convention use * * \sa enum box_error_code */ pub fn box_error_set(file: *const ::std::os::raw::c_char, line: ::std::os::raw::c_uint, code: u32, format: *const ::std::os::raw::c_char, ...) -> ::std::os::raw::c_int; } /* }}} Error */ /* {{{ Latch */ #[repr(C)] #[derive(Debug, Copy)] pub struct box_latch { pub _address: u8, } impl Clone for box_latch { fn clone(&self) -> Self { *self } } /** * A lock for cooperative multitasking environment */ pub type BoxLatch = box_latch; extern "C" { /** * Allocate and initialize the new latch. * \returns latch */ pub fn box_latch_new() -> *mut BoxLatch; /** * Destroy and free the latch. * \param latch latch */ pub fn box_latch_delete(latch: *mut BoxLatch); /** * Lock a latch. Waits indefinitely until the current fiber can gain access to * the latch. * * \param latch a latch */ pub fn box_latch_lock(latch: *mut BoxLatch); /** * Try to lock a latch. Return immediately if the latch is locked. * \param latch a latch * \retval 0 - success * \retval 1 - the latch is locked. */ pub fn BoxLatchrylock(latch: *mut BoxLatch) -> ::std::os::raw::c_int; /** * Unlock a latch. The fiber calling this function must * own the latch. * * \param latch a latch */ pub fn box_latch_unlock(latch: *mut BoxLatch); } /* }}} Latch */ /* {{{ Clock */ extern "C" { pub fn clock_realtime() -> f64; pub fn clock_monotonic() -> f64; pub fn clock_process() -> f64; pub fn clock_thread() -> f64; pub fn clock_realtime64() -> u64; pub fn clock_monotonic64() -> u64; pub fn clock_process64() -> u64; pub fn clock_thread64() -> u64; } /* }}} Clock */