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

source ·
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,
}
Expand description

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§

source§

impl Layer

source

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.
source

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.
source

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.
source

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.
source

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.
source

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.
source

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.

source

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.
source

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.
source

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.
source

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§

source§

impl From<(i32, LayerDto)> for Layer

source§

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

Converts to this type from the input type.
source§

impl From<Layer> for LayerDto

source§

fn from(layer: Layer) -> Self

Converts to this type from the input type.
source§

impl HasTable for Layer

§

type Table = table

The table this type is associated with.
source§

fn table() -> Self::Table

Returns the table this type is associated with.
source§

impl<'ident> Identifiable for &'ident Layer

§

type Id = &'ident Uuid

The type of this struct’s identifier. Read more
source§

fn id(self) -> Self::Id

Returns the identifier for this record. Read more
source§

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 Read more
source§

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 Read more
source§

fn insert_into( self, table: T ) -> InsertStatement<T, Self::Values, Insert, NoReturningClause>where T: Table, Self: Sized,

Insert self into a given table. Read more
source§

impl Insertable<table> for Layer

source§

impl<__DB: Backend, __ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6> Queryable<(__ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6), __DB> for Layerwhere (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. Read more
source§

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

Construct an instance of this type
source§

impl UndecoratedInsertRecord<table> for Layer

Auto Trait Implementations§

§

impl RefUnwindSafe for Layer

§

impl Send for Layer

§

impl Sync for Layer

§

impl Unpin for Layer

§

impl UnwindSafe for Layer

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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> IntoSql for T

source§

fn into_sql<T>(self) -> Self::Expressionwhere Self: AsExpression<T> + Sized, T: SqlType + TypedExpressionType,

Convert self to an expression for Diesel’s query builder. Read more
source§

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expressionwhere &'a Self: AsExpression<T>, T: SqlType + TypedExpressionType,

Convert &self to an expression for Diesel’s query builder. Read more
source§

impl<T> Paginate for T

source§

fn paginate(self, page: Option<i32>) -> PaginatedQuery<T>

Return a paginated version of a query for a specific page number.
source§

impl<T, Conn> RunQueryDsl<Conn> for T

source§

fn execute<'query, 'conn>( self, conn: &'conn mut Conn ) -> <Conn as AsyncConnection>::ExecuteFuture<'conn, 'query>where Conn: AsyncConnection + Send, Self: ExecuteDsl<Conn, <Conn as AsyncConnection>::Backend> + 'query,

Executes the given command, returning the number of rows affected. Read more
source§

fn load<'query, U, 'conn>( self, conn: &'conn mut Conn ) -> AndThen<Self::LoadFuture<'conn>, TryCollect<Self::Stream<'conn>, Vec<U, Global>>, fn(_: Self::Stream<'conn>) -> TryCollect<Self::Stream<'conn>, Vec<U, Global>>>where U: Send, Conn: AsyncConnection, Self: LoadQuery<'query, Conn, U> + 'query,

Executes the given query, returning a Vec with the returned rows. Read more
source§

fn load_stream<'conn, 'query, U>( self, conn: &'conn mut Conn ) -> Self::LoadFuture<'conn>where Conn: AsyncConnection, U: 'conn, Self: LoadQuery<'query, Conn, U> + 'query,

Executes the given query, returning a Stream with the returned rows. Read more
source§

fn get_result<'query, 'conn, U>( self, conn: &'conn mut Conn ) -> AndThen<Self::LoadFuture<'conn>, Map<StreamFuture<Pin<Box<Self::Stream<'conn>, Global>>>, fn(_: (Option<Result<U, Error>>, Pin<Box<Self::Stream<'conn>, Global>>)) -> Result<U, Error>>, fn(_: Self::Stream<'conn>) -> Map<StreamFuture<Pin<Box<Self::Stream<'conn>, Global>>>, fn(_: (Option<Result<U, Error>>, Pin<Box<Self::Stream<'conn>, Global>>)) -> Result<U, Error>>>where U: Send + 'conn, Conn: AsyncConnection, Self: LoadQuery<'query, Conn, U> + 'query,

Runs the command, and returns the affected row. Read more
source§

fn get_results<'query, U, 'conn>( self, conn: &'conn mut Conn ) -> AndThen<Self::LoadFuture<'conn>, TryCollect<Self::Stream<'conn>, Vec<U, Global>>, fn(_: Self::Stream<'conn>) -> TryCollect<Self::Stream<'conn>, Vec<U, Global>>>where U: Send, Conn: AsyncConnection, Self: LoadQuery<'query, Conn, U> + 'query,

Runs the command, returning an Vec with the affected rows. Read more
source§

fn first<'query, 'conn, U>( self, conn: &'conn mut Conn ) -> AndThen<<Self::Output as LoadQuery<'query, Conn, U>>::LoadFuture<'conn>, Map<StreamFuture<Pin<Box<<Self::Output as LoadQuery<'query, Conn, U>>::Stream<'conn>, Global>>>, fn(_: (Option<Result<U, Error>>, Pin<Box<<Self::Output as LoadQuery<'query, Conn, U>>::Stream<'conn>, Global>>)) -> Result<U, Error>>, fn(_: <Self::Output as LoadQuery<'query, Conn, U>>::Stream<'conn>) -> Map<StreamFuture<Pin<Box<<Self::Output as LoadQuery<'query, Conn, U>>::Stream<'conn>, Global>>>, fn(_: (Option<Result<U, Error>>, Pin<Box<<Self::Output as LoadQuery<'query, Conn, U>>::Stream<'conn>, Global>>)) -> Result<U, Error>>>where U: Send + 'conn, Conn: AsyncConnection, Self: LimitDsl, Self::Output: LoadQuery<'query, Conn, U> + Send + 'query,

Attempts to load a single record. Read more
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, ST, DB> StaticallySizedRow<ST, DB> for Twhere ST: SqlTypeOrSelectable + TupleSize, T: Queryable<ST, DB>, DB: Backend,

source§

const FIELD_COUNT: usize = <ST as crate::util::TupleSize>::SIZE

The number of fields that this type will consume.
source§

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

§

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 Twhere U: TryFrom<T>,

§

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<V, T> VZip<V> for Twhere V: MultiLane<T>,

source§

fn vzip(self) -> V

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