From f1c50e2cbe757926df7a94284eb0246c66394779 Mon Sep 17 00:00:00 2001 From: Stewart Stewart Date: Sun, 18 Dec 2016 16:33:03 -0500 Subject: add documentation for sameId --- src/main/scala/xyz/driver/core/core.scala | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'src/main') diff --git a/src/main/scala/xyz/driver/core/core.scala b/src/main/scala/xyz/driver/core/core.scala index ce6be34..1a6bdd7 100644 --- a/src/main/scala/xyz/driver/core/core.scala +++ b/src/main/scala/xyz/driver/core/core.scala @@ -25,6 +25,13 @@ package object core { package core { + /** + * Evidence that Id[A] can be safely converted to Id[B]. + * e.g. `implicit val CaseId = Id.sameId[Case, CasesRow]` + * if `CaseId` is in scope, we can use either of: + * `casesRowId.asId[Case]` or `caseId.asId[CasesRow]` + * Override convert for custom Id conversions. + */ @implicitNotFound("No evidence that ${A} has the same Id as ${B}") sealed trait SameId[A, B] { def convert(id: Id[A]): Id[B] = Id[B](id.value) -- cgit v1.2.3