Struct tarantool_module::sequence::Sequence

pub struct Sequence { /* fields omitted */ }

A sequence is a generator of ordered integer values.

Implementations

impl Sequence

pub fn find(name: &str) -> Result<Option<Self>, Error>

Find sequence by name.

pub fn next(&mut self) -> Result<i64, Error>

Generate the next value and return it.

The generation algorithm is simple:

• If this is the first time, then return the start value.
• If the previous value plus the increment value is less than the minimum value or greater than the maximum value, that is "overflow", so either raise an error (if cycle = false) or return the maximum value (if cycle = true and step < 0) or return the minimum value (if cycle = true and step > 0).

If there was no error, then save the returned result, it is now the "previous value".

pub fn set(&mut self, new_value: i64) -> Result<(), Error>

Set the "previous value" to new_value.

This function requires a "write" privilege on the sequence.

pub fn reset(&mut self) -> Result<(), Error>

Set the sequence back to its original state.

The effect is that a subsequent next will return the start value. This function requires a "write" privilege on the sequence.