Struct backend::model::entity::layers::Layer

pub struct Layer {
    pub map_id: i32,
    pub type_: LayerType,
    pub name: String,
    pub is_alternative: bool,
    pub id: Uuid,
    pub marked_deleted: Option<NaiveDateTime>,
    pub order_index: i32,
}

The Layer entity.

Fields

map_id: i32

The id of the map this layer belongs to.

type_: LayerType

The type of layer.

name: String

The name of the layer.

is_alternative: bool

A flag indicating if this layer is an user created alternative.

id: Uuid

The id of the layer.

marked_deleted: Option<NaiveDateTime>

Set if the layer has been soft-deleted

order_index: i32

Order within the map.

Implementations

impl Layer

pub async fn find( search_parameters: LayerSearchParameters, conn: &mut AsyncPgConnection, ) -> QueryResult<Vec<LayerDto>>

Get a page of layers. Can be filtered by its active status if one is provided in search_parameters.

Errors

• Unknown, diesel doesn’t say why it might error.

pub async fn find_by_id( id: Uuid, conn: &mut AsyncPgConnection, ) -> QueryResult<Self>

Fetch layer by id from the database.

Errors

• Unknown, diesel doesn’t say why it might error.

async fn defer_unique_order_index_constraint( transaction: &mut AsyncPgConnection, ) -> QueryResult<()>

Defer checking of the unique constraint (map_id, order_index, marked_deleted) until the end of the current transaction.

Errors

• Unknown, diesel doesn’t say why it might error.

async fn shift_order_indices_by( map_id: i32, order_index: i32, increment: bool, transaction: &mut AsyncPgConnection, ) -> QueryResult<()>

Helper to increment or decrement all layers with order_index greater or equal the provided index. This is used when layers get deleted/restored to shift all subsequent layers up/down one place.

Errors

• Unknown, diesel doesn’t say why it might error.

pub async fn create( map_id: i32, new_layer: LayerDto, conn: &mut AsyncPgConnection, ) -> QueryResult<LayerDto>

Rename a layer in the database.

Errors

• Unknown, diesel doesn’t say why it might error.

pub async fn reorder( new_order: Vec<Uuid>, conn: &mut AsyncPgConnection, ) -> QueryResult<()>

Reorder multiple layers in the database. That means setting all order_index fields.

Errors

• Unknown, diesel doesn’t say why it might error.

fn do_order_update( updates: Vec<UpdateLayerOrderIndex>, conn: &mut AsyncPgConnection, ) -> Vec<impl Future<Output = QueryResult<usize>>>

This helper function is needed, with explicit type annotations.

pub async fn rename( dto: LayerRenameDto, conn: &mut AsyncPgConnection, ) -> QueryResult<()>

Rename layers in the database.

Errors

• Unknown, diesel doesn’t say why it might error.

async fn set_marked_deleted( drawing_layer_id: Uuid, marked_deleted: bool, conn: &mut AsyncPgConnection, ) -> QueryResult<Self>

Soft-delete or restoring layers in the database by settings the marked_deleted field.

Errors

• Unknown, diesel doesn’t say why it might error.

pub async fn delete( map_id: i32, layer_id: Uuid, conn: &mut AsyncPgConnection, ) -> QueryResult<()>

Soft-delete a layers in the database by settings the marked_deleted field to the current date. All subsequent layers are moved one order_index down.

Errors

• Unknown, diesel doesn’t say why it might error.

pub async fn restore( map_id: i32, layer_id: Uuid, conn: &mut AsyncPgConnection, ) -> QueryResult<()>

Restore a layers that has been marked deleted in the database. The layer takes on its previous order_index and all subsequent layers are moved one layer down.

Errors

• Unknown, diesel doesn’t say why it might error.

Trait Implementations

impl From<(i32, LayerDto)> for Layer

fn from(tuple: (i32, LayerDto)) -> Self

Converts to this type from the input type.

impl From<Layer> for LayerDto

fn from(layer: Layer) -> Self

Converts to this type from the input type.

impl HasTable for Layer

type Table = table

The table this type is associated with.

fn table() -> Self::Table

Returns the table this type is associated with.

impl<'ident> Identifiable for &'ident Layer

type Id = &'ident Uuid

The type of this struct’s identifier.

fn id(self) -> Self::Id

Returns the identifier for this record.

impl<'insert> Insertable<table> for &'insert Layer

type Values = <(Option<Grouped<Eq<map_id, <&'insert i32 as AsExpression<<map_id as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<type_, <&'insert LayerType as AsExpression<<type_ as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<name, <&'insert String as AsExpression<<name as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<is_alternative, <&'insert bool as AsExpression<<is_alternative as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<id, <&'insert Uuid as AsExpression<<id as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<marked_deleted, <&'insert NaiveDateTime as AsExpression<<marked_deleted as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<order_index, <&'insert i32 as AsExpression<<order_index as Expression>::SqlType>>::Expression>>>) as Insertable<table>>::Values

The VALUES clause to insert these records

fn values( self, ) -> <(Option<Eq<map_id, &'insert i32>>, Option<Eq<type_, &'insert LayerType>>, Option<Eq<name, &'insert String>>, Option<Eq<is_alternative, &'insert bool>>, Option<Eq<id, &'insert Uuid>>, Option<Eq<marked_deleted, &'insert NaiveDateTime>>, Option<Eq<order_index, &'insert i32>>) as Insertable<table>>::Values

Construct Self::Values

fn insert_into(self, table: T) -> InsertStatement<T, Self::Values>

where T: Table, Self: Sized,

Insert self into a given table.

impl Insertable<table> for Layer

type Values = <(Option<Grouped<Eq<map_id, <i32 as AsExpression<<map_id as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<type_, <LayerType as AsExpression<<type_ as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<name, <String as AsExpression<<name as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<is_alternative, <bool as AsExpression<<is_alternative as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<id, <Uuid as AsExpression<<id as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<marked_deleted, <NaiveDateTime as AsExpression<<marked_deleted as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<order_index, <i32 as AsExpression<<order_index as Expression>::SqlType>>::Expression>>>) as Insertable<table>>::Values

The VALUES clause to insert these records

fn values( self, ) -> <(Option<Eq<map_id, i32>>, Option<Eq<type_, LayerType>>, Option<Eq<name, String>>, Option<Eq<is_alternative, bool>>, Option<Eq<id, Uuid>>, Option<Eq<marked_deleted, NaiveDateTime>>, Option<Eq<order_index, i32>>) as Insertable<table>>::Values

Construct Self::Values

fn insert_into(self, table: T) -> InsertStatement<T, Self::Values>

where T: Table, Self: Sized,

Insert self into a given table.

impl<__DB: Backend, __ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6> Queryable<(__ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6), __DB> for Layer

where (i32, LayerType, String, bool, Uuid, Option<NaiveDateTime>, i32): FromStaticSqlRow<(__ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6), __DB>,

type Row = (i32, LayerType, String, bool, Uuid, Option<NaiveDateTime>, i32)

The Rust type you’d like to map from.

fn build(row: Self::Row) -> Result<Self>

Construct an instance of this type

impl UndecoratedInsertRecord<table> for Layer