Struct backend::model::entity::Map

source ·
pub struct Map {
Show 17 fields pub id: i32, pub name: String, pub deletion_date: Option<NaiveDate>, pub last_visit: Option<NaiveDate>, pub is_inactive: bool, pub zoom_factor: i16, pub honors: i16, pub visits: i16, pub harvested: i16, pub privacy: PrivacyOption, pub description: Option<String>, pub location: Option<Point>, pub created_by: Uuid, pub geometry: Polygon<Point>, pub created_at: NaiveDateTime, pub modified_at: NaiveDateTime, pub modified_by: Uuid,
}
Expand description

The Map entity.

Fields§

§id: i32

The id of the map.

§name: String

The name of the map.

§deletion_date: Option<NaiveDate>

The date the map is supposed to be deleted.

§last_visit: Option<NaiveDate>

The date the last time the map view was opened by any user.

§is_inactive: bool

A flag indicating if this map is marked for deletion.

§zoom_factor: i16

The zoom factor of the map.

§honors: i16

The amount of honors the map received.

§visits: i16

The amount of visits the map had.

§harvested: i16

The amount of plants harvested on the map.

§privacy: PrivacyOption

An enum indicating if this map is private or not.

§description: Option<String>

The description of the map.

§location: Option<Point>

The location of the map as a latitude/longitude point.

§created_by: Uuid

The id of the creator of the map.

§geometry: Polygon<Point>

The geometry of the map.

§created_at: NaiveDateTime

When the map was created.

§modified_at: NaiveDateTime

When a map was last modified, e.g., by modifying plantings.

§modified_by: Uuid

By whom the map was last modified.

Implementations§

source§

impl Map

source

pub async fn find( search_parameters: MapSearchParameters, page_parameters: PageParameters, conn: &mut AsyncPgConnection ) -> QueryResult<Page<MapDto>>

Get the top maps matching the search query.

Can be filtered by is_inactive and created_by if provided in search_parameters. This will be done with equals and is additional functionality for maps (when compared to plant search).

Uses pg_trgm to find matches in name. Ranks using the pg_trgm function similarity().

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

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

Fetch map by id from the database.

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

pub async fn is_name_taken( map_name: &str, conn: &mut AsyncPgConnection ) -> QueryResult<bool>

Checks if a map with this name already exists in the database.

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

pub async fn create( new_map: NewMapDto, user_id: Uuid, conn: &mut AsyncPgConnection ) -> QueryResult<MapDto>

Create a new map in the database.

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

pub async fn update( map_update: UpdateMapDto, id: i32, conn: &mut AsyncPgConnection ) -> QueryResult<MapDto>

Update a map in the database.

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

pub async fn mark_for_deletion( id: i32, conn: &mut AsyncPgConnection ) -> QueryResult<MapDto>

Marks a map for deletion using the systems current date and time.

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

pub async fn update_geometry( map_update_bounds: UpdateMapGeometryDto, id: i32, conn: &mut AsyncPgConnection ) -> QueryResult<MapDto>

Update a maps bounds in the database.

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

pub async fn update_modified_metadata( id: i32, user_id: Uuid, time: NaiveDateTime, conn: &mut AsyncPgConnection ) -> QueryResult<()>

Update modified metadata (modified_at, modified_by) of the map.

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

Trait Implementations§

source§

impl From<Map> for MapDto

source§

fn from(map: Map) -> Self

Converts to this type from the input type.
source§

impl HasTable for Map

§

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 Map

§

type Id = &'ident i32

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<__DB: Backend, __ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6, __ST7, __ST8, __ST9, __ST10, __ST11, __ST12, __ST13, __ST14, __ST15, __ST16> Queryable<(__ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6, __ST7, __ST8, __ST9, __ST10, __ST11, __ST12, __ST13, __ST14, __ST15, __ST16), __DB> for Mapwhere (i32, String, Option<NaiveDate>, Option<NaiveDate>, bool, i16, i16, i16, i16, PrivacyOption, Option<String>, Option<Point>, Uuid, Polygon<Point>, NaiveDateTime, NaiveDateTime, Uuid): FromStaticSqlRow<(__ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6, __ST7, __ST8, __ST9, __ST10, __ST11, __ST12, __ST13, __ST14, __ST15, __ST16), __DB>,

§

type Row = (i32, String, Option<NaiveDate>, Option<NaiveDate>, bool, i16, i16, i16, i16, PrivacyOption, Option<String>, Option<Point>, Uuid, Polygon<Point>, NaiveDateTime, NaiveDateTime, Uuid)

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

Auto Trait Implementations§

§

impl RefUnwindSafe for Map

§

impl Send for Map

§

impl Sync for Map

§

impl Unpin for Map

§

impl UnwindSafe for Map

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