Trait/Object

shapeless

LabelledGeneric

Related Docs: object LabelledGeneric | package shapeless

Permalink

trait LabelledGeneric[T] extends Serializable

LabelledGeneric is similar to Generic, but includes information about field names or class names in addition to the raw structure.

Continuing the example from shapeless.Generic, we use LabelledGeneric to convert an object to an shapeless.HList:

scala> val lgenDog = LabelledGeneric[Dog]
lgenDog: shapeless.LabelledGeneric[Dog]{ type Repr = Record.`'name -> String, 'bonesHidden -> Int`.T } = ...

scala> lgenDog.to(odie)
res15: lgenDog.Repr = odie :: 3 :: HNil

Note that the representation does not include the labels! The labels are actually encoded in the generic type representation using shapeless.Witness types.

As with shapeless.Generic, the representation for Animal captures the subclass embedding rather than the fields in the class, using shapeless.Coproduct:

scala> val lgenAnimal = LabelledGeneric[Animal]
lgenAnimal: shapeless.LabelledGeneric[Animal]{ type Repr = Union.`'Cat -> Cat, 'Dog -> Dog`.T } = ...

scala> lgenAnimal.to(odie)
res16: lgenAnimal.Repr = Dog(odie,3)

scala> genAnimal.to(odie) match { case Inr(Inl(dog)) => dog ; case _ => ???}
res19: Dog = Dog(odie,3)
T

the type which this instance can convert to and from a labelled generic representation

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LabelledGeneric
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Repr

    Permalink

    The generic representation type for {T}, which will be composed of {Coproduct} and {HList} types

Abstract Value Members

  1. abstract def from(r: Repr): T

    Permalink

    Convert an instance of the generic representation to an instance of the concrete type

  2. abstract def to(t: T): Repr

    Permalink

    Convert an instance of the concrete type to the generic value representation

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped