Struct spacetimedb_primitives::Constraints

pub struct Constraints { /* private fields */ }

Represents constraints for a database table.

Implementations

impl Constraints

pub const fn unset() -> Self

Creates a new Constraints instance with no constraints set.

pub const fn indexed() -> Self

Creates a new Constraints instance with ColumnAttribute::INDEXED set.

pub const fn unique() -> Self

Creates a new Constraints instance with ColumnAttribute::UNIQUE constraint set.

pub const fn identity() -> Self

Creates a new Constraints instance with ColumnAttribute::IDENTITY set.

pub const fn primary_key() -> Self

Creates a new Constraints instance with ColumnAttribute::PRIMARY_KEY set.

pub const fn primary_key_auto() -> Self

Creates a new Constraints instance with ColumnAttribute::PRIMARY_KEY_AUTO set.

pub const fn primary_key_identity() -> Self

Creates a new Constraints instance with ColumnAttribute::PRIMARY_KEY_IDENTITY set.

pub fn push(self, other: Constraints) -> Self

Adds a constraint to the existing constraints.

Example

use spacetimedb_primitives::Constraints;

let constraints = Constraints::unset().push(Constraints::indexed());
assert!(constraints.has_indexed());

pub const fn bits(&self) -> u8

Returns the bits representing the constraints.

pub fn kind(&self) -> ConstraintKind

Returns the ConstraintKind of constraints as an enum variant.

NOTE: This represent the higher possible representation of a constraints, so for example IDENTITY imply that is INDEXED, UNIQUE

pub fn contains(&self, other: &Self) -> bool

pub const fn has_unique(&self) -> bool

Checks if the ‘UNIQUE’ constraint is set.

pub const fn has_indexed(&self) -> bool

Checks if the ‘INDEXED’ constraint is set.

pub const fn has_autoinc(&self) -> bool

Checks if either ‘IDENTITY’ or ‘PRIMARY_KEY_AUTO’ constraints are set because the imply the use of auto increment sequence.

pub const fn has_primary_key(&self) -> bool

Checks if the ‘PRIMARY_KEY’ constraint is set.

Trait Implementations

impl Clone for Constraints

fn clone(&self) -> Constraints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Constraints

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

Formats the value using the given formatter.

impl Hash for Constraints

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Constraints

fn cmp(&self, other: &Constraints) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Constraints

fn eq(&self, other: &Constraints) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Constraints

fn partial_cmp(&self, other: &Constraints) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<ColumnAttribute> for Constraints

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: ColumnAttribute) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for Constraints

type Error = ()

The type returned in the event of a conversion error.

fn try_from(v: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Constraints

impl Eq for Constraints

impl StructuralPartialEq for Constraints