Skip to main content

SequenceConfig

Struct SequenceConfig 

Source
pub struct SequenceConfig {
    pub cache_size: i32,
    pub range_min: i64,
    pub range_max: i64,
    pub initial_value: i64,
    pub allow_create: bool,
    pub decrement: bool,
    pub exclusive_create: bool,
    pub wrap: bool,
}
Expand description

Specifies the attributes of a sequence.

Fields§

§cache_size: i32

Number of elements cached in the sequence handle (default 20).

default is 0 but the task specifies 20 as the noxu default for pre-fetching. A value of 0 disables caching (every get hits the DB).

§range_min: i64

Minimum value for the sequence (default i64::MIN).

§range_max: i64

Maximum value for the sequence (default i64::MAX).

§initial_value: i64

Initial value when the sequence is first created (default 0).

§allow_create: bool

Create the sequence if it does not exist (default false).

§decrement: bool

The sequence counts downward when true (default false — counts upward).

§exclusive_create: bool

Fail if the sequence already exists (default false).

§wrap: bool

Wrap around when the range limit is reached (default false).

Implementations§

Source§

impl SequenceConfig

Source

pub fn new() -> Self

Creates a SequenceConfig with all defaults.

Source

pub fn with_cache_size(self, cache_size: i32) -> Self

Sets the number of cached elements.

Source

pub fn with_range(self, min: i64, max: i64) -> Self

Sets the sequence range.

Source

pub fn with_range_min(self, min: i64) -> Self

Sets the minimum value of the range.

Source

pub fn with_range_max(self, max: i64) -> Self

Sets the maximum value of the range.

Source

pub fn with_initial_value(self, initial_value: i64) -> Self

Sets the initial value (only effective on creation).

Source

pub fn with_allow_create(self, allow_create: bool) -> Self

Configures whether the sequence is created if missing.

Source

pub fn with_decrement(self, decrement: bool) -> Self

Configures whether the sequence decrements instead of incrementing.

Source

pub fn with_exclusive_create(self, exclusive_create: bool) -> Self

Configures whether to fail when the sequence already exists.

Source

pub fn with_wrap(self, wrap: bool) -> Self

Configures whether to wrap around at the range boundary.

Trait Implementations§

Source§

impl Clone for SequenceConfig

Source§

fn clone(&self) -> SequenceConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SequenceConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for SequenceConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more