Crate tarantool_rust_module [] [src]

Structs

BuiltinVaListTag
addrinfo
box_function_ctx
box_latch
error
fiber
iterator
slab_cache

Return slab_cache suitable to use with tarantool/small library

tuple
tuple_format
tuple_iterator

Enums

CoioFlags
IteratorType

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.

SayLevel

Log levels

Constants

BOX_CLUSTER_ID
BOX_FUNC_ID
BOX_ID_NIL
BOX_INDEX_ID
BOX_PRIV_ID
BOX_SCHEMA_ID
BOX_SPACE_ID
BOX_SYSTEM_ID_MAX
BOX_SYSTEM_ID_MIN
BOX_USER_ID
BOX_VFUNC_ID
BOX_VINDEX_ID
BOX_VPRIV_ID
BOX_VSPACE_ID
BOX_VUSER_ID

Statics

_say
log_level

Functions

BoxErrorype

Return the error type, e.g. "ClientError", "SocketError", etc. \param error \return not-null string

BoxLatchrylock

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.

BoxTupleo_buf

Dump raw MsgPack data to the memory byffer \a buf of size \a size.

box_delete

Execute an DELETE request.

box_error_clear

Clear the last error.

box_error_code

Return IPROTO error code \param error error \return enum box_error_code

box_error_last

Get the information about the last API call error.

box_error_message

Return the error message \param error error \return not-null string

box_error_set

Set the last error.

box_index_bsize

Return the number of bytes used in memory by the index.

box_index_count

Count the number of tuple matched the provided key.

box_index_get

Get a tuple from index by the key.

box_index_id_by_name

Find index id by name.

box_index_iterator

Allocate and initialize iterator for space_id, index_id.

box_index_len

Return the number of element in the index.

box_index_max

Return a last (maximal) tuple matched the provided key.

box_index_min

Return a first (minimal) tuple matched the provided key.

box_index_random

Return a random tuple from the index (useful for statistical analysis).

box_insert

Execute an INSERT request.

box_iterator_free

Destroy and deallocate iterator.

box_iterator_next

Retrive the next item from the \a iterator.

box_latch_delete

Destroy and free the latch. \param latch latch

box_latch_lock

Lock a latch. Waits indefinitely until the current fiber can gain access to the latch.

box_latch_new

Allocate and initialize the new latch. \returns latch

box_latch_unlock

Unlock a latch. The fiber calling this function must own the latch.

box_replace

Execute an REPLACE request.

box_return_tuple

Return a tuple from stored C procedure.

box_space_id_by_name

Find space id by name.

box_truncate

Truncate space.

box_tuple_bsize

Return the number of bytes used to store internal tuple data (MsgPack Array). \param tuple a tuple

box_tuple_extract_key
box_tuple_field

Return the raw tuple field in MsgPack format.

box_tuple_field_count

Return the number of fields in tuple (the size of MsgPack Array). \param tuple a tuple

box_tuple_format

Return the associated format. \param tuple tuple \return tuple_format

box_tuple_format_default

Tuple Format.

box_tuple_iterator

Allocate and initialize a new tuple iterator. The tuple iterator allow to iterate over fields at root level of MsgPack array.

box_tuple_iterator_free

Destroy and free tuple iterator

box_tuple_new

Allocate and initialize a new tuple from a raw MsgPack Array data.

box_tuple_next

Return the next tuple field from tuple iterator. The returned buffer is valid until next call to box_tuple_* API.

box_tuple_position

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.

box_tuple_ref

Increase the reference counter of tuple.

box_tuple_rewind

Rewind iterator to the initial position.

box_tuple_seek

Seek the tuple iterator.

box_tuple_unref

Decrease the reference counter of tuple.

box_tuple_update
box_tuple_upsert
box_txn

Return true if there is an active transaction.

box_txn_alloc

Allocate memory on txn memory pool. The memory is automatically deallocated when the transaction is committed or rolled back.

box_txn_begin

Begin a transaction in the current fiber.

box_txn_commit

Commit the current transaction. @retval 0 - success @retval -1 - failed, perhaps a disk write failure. started

box_txn_rollback

Rollback the current transaction. May fail if called from a nested statement.

box_update

Execute an UPDATE request.

box_upsert

Execute an UPSERT request.

clock_monotonic
clock_monotonic64
clock_process
clock_process64
clock_realtime
clock_realtime64
clock_thread
clock_thread64
coio_call

Create new eio task with specified function and arguments. Yield and wait until the task is complete or a timeout occurs.

coio_close

Close the fd and wake any fiber blocked in coio_wait() call on this fd.

coio_getaddrinfo

Fiber-friendly version of getaddrinfo(3).

coio_wait

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.

cord_slab_cache
fiber_cancel

Cancel the subject fiber. (set FIBER_IS_CANCELLED flag)

fiber_is_cancelled

Check current fiber for cancellation (it must be checked manually).

fiber_join

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.

fiber_new

Create a new fiber.

fiber_reschedule

Reschedule fiber to end of event loop cycle.

fiber_set_cancellable

Make it possible or not possible to wakeup the current fiber immediately when it's cancelled.

fiber_set_joinable

Set fiber to be joinable (false by default). \param yesno status to set

fiber_sleep

Put the current fiber to sleep for at least 's' seconds.

fiber_start

Start execution of created fiber.

fiber_time

Report loop begin time as double (cheap).

fiber_time64

Report loop begin time as 64-bit int.

fiber_wakeup

Interrupt a synchronous wait of a fiber

fiber_yield

Return control to another fiber and wait until it'll be woken.

rustproc
say_log_level_is_enabled

Type Definitions

BoxError

Error - contains information about error.

BoxFunctionCtx
BoxIterator

A space iterator

BoxLatch

A lock for cooperative multitasking environment

BoxTuple

Tuple

BoxTupleFormat
BoxTupleIterator

Tuple iterator

BuiltinVaList
FiberFunc

Fiber - contains information about fiber

SayFunc