Struct barrel::types::Type

pub struct Type {
    pub nullable: bool,
    pub unique: bool,
    pub increments: bool,
    pub indexed: bool,
    pub primary: bool,
    pub default: Option<WrappedDefault<'static>>,
    pub size: Option<usize>,
    pub inner: BaseType,
}

A database column type and all the metadata attached to it

Using this struct directly is not recommended. Instead, you should be using the constructor APIs in the types module.

A Type is an enum provided to other barrel APIs in order to generate SQL datatypes. Working with them directly is possible but not recommended.

Instead, you can use these helper functions to construct Type enums of different…types and constraints. Field metadata is added via chainable factory pattern functions.

Default values

If no additional arguments are provided, some assumptions will be made about the metadata of a column type.

• nullable: false
• indexed: false
• unique: false
• default: None
• size: None (which will error if size is important)

Examples

extern crate barrel;
use barrel::types::*;

// Make your own Primary key :)
let col = integer().increments(true).unique(true);

Fields

nullable: bool

unique: bool

increments: bool

indexed: bool

primary: bool

default: Option<WrappedDefault<'static>>

size: Option<usize>

inner: BaseType

Implementations

impl Type

This is a public API, be considered about breaking thigns

pub fn nullable(self, arg: bool) -> Self

Set the nullability of this type

pub fn unique(self, arg: bool) -> Self

Set the uniqueness of this type

pub fn increments(self, arg: bool) -> Self

Specify if this type should auto-increment

pub fn indexed(self, arg: bool) -> Self

Specify if this type should be indexed by your SQL implementation

pub fn primary(self, arg: bool) -> Self

Specify if this type should be a primary key

pub fn default(self, arg: impl Into<WrappedDefault<'static>>) -> Self

Provide a default value for a type column

pub fn size(self, arg: usize) -> Self

Specify a size limit (important or varchar & similar)

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl PartialEq for Type

fn eq(&self, other: &Type) -> 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 StructuralPartialEq for Type