Data.Greskell.AsLabel

Since: 0.2.2.0

AsLabel

newtype AsLabel a

AsLabel a represents a label string used in .as step pointing to the data of type a.

Constructors

AsLabel

Fields

• unAsLabel :: Text

Instances

Functor AsLabel

Unsafely convert the phantom type.

Defined in Data.Greskell.AsLabel

Methods

fmap :: (a -> b) -> AsLabel a -> AsLabel b

(<$) :: a -> AsLabel b -> AsLabel a

Eq (AsLabel a)

Defined in Data.Greskell.AsLabel

Methods

(==) :: AsLabel a -> AsLabel a -> Bool

(/=) :: AsLabel a -> AsLabel a -> Bool

Ord (AsLabel a)

Defined in Data.Greskell.AsLabel

Methods

compare :: AsLabel a -> AsLabel a -> Ordering

(<) :: AsLabel a -> AsLabel a -> Bool

(<=) :: AsLabel a -> AsLabel a -> Bool

(>) :: AsLabel a -> AsLabel a -> Bool

(>=) :: AsLabel a -> AsLabel a -> Bool

max :: AsLabel a -> AsLabel a -> AsLabel a

min :: AsLabel a -> AsLabel a -> AsLabel a

Show (AsLabel a)

Defined in Data.Greskell.AsLabel

Methods

showsPrec :: Int -> AsLabel a -> ShowS

show :: AsLabel a -> String

showList :: [AsLabel a] -> ShowS

IsString (AsLabel a)

Since: 1.0.0.0

Defined in Data.Greskell.AsLabel

Methods

fromString :: String -> AsLabel a

Hashable (AsLabel a)

Defined in Data.Greskell.AsLabel

Methods

hashWithSalt :: Int -> AsLabel a -> Int

hash :: AsLabel a -> Int

ToGreskell (AsLabel a)

Returns the Text as a Gremlin string.

Defined in Data.Greskell.AsLabel

Associated Types

type GreskellReturn (AsLabel a)

Methods

toGreskell :: AsLabel a -> Greskell (GreskellReturn (AsLabel a))

PMapKey (AsLabel a)

Since: 1.0.0.0

Defined in Data.Greskell.AsLabel

Associated Types

type PMapValue (AsLabel a)

Methods

keyText :: AsLabel a -> Text

type GreskellReturn (AsLabel a)

Defined in Data.Greskell.AsLabel

type GreskellReturn (AsLabel a) = Text

type PMapValue (AsLabel a)

Defined in Data.Greskell.AsLabel

type PMapValue (AsLabel a) = a

type SelectedMap = PMap Single

A map keyed with AsLabel. Obtained from .select step, for example.

unsafeCastAsLabel :: AsLabel a -> AsLabel b

Unsafely cast the phantom type of the AsLabel.

Since: 1.1.0.0

Re-exports

lookup :: (PMapKey k, NonEmptyLike c) => k -> PMap c v -> Maybe v

Lookup the first value for the key from PMap.

lookupM :: (PMapKey k, NonEmptyLike c, MonadThrow m) => k -> PMap c v -> m v

MonadThrow version of lookup. If there is no value for the key, it throws PMapNoSuchKey.

lookupAs :: (PMapKey k, NonEmptyLike c, PMapValue k ~ a, FromGraphSON a) => k -> PMap c GValue -> Either PMapLookupException a

Lookup the value and parse it into a.

lookupAsM :: (PMapKey k, NonEmptyLike c, PMapValue k ~ a, FromGraphSON a, MonadThrow m) => k -> PMap c GValue -> m a

MonadThrow version of lookupAs.

data PMapLookupException

An Exception raised when looking up values from PMap.

Since: 1.0.0.0

Constructors

PMapNoSuchKey Text

The PMap doesn't have the given key.

PMapParseError Text String

Failed to parse the value into the type that the PMapKey indicates. The Text is the key, and the String is the error message.

Instances

Eq PMapLookupException

Defined in Data.Greskell.PMap

Methods

(==) :: PMapLookupException -> PMapLookupException -> Bool

(/=) :: PMapLookupException -> PMapLookupException -> Bool

Ord PMapLookupException

Defined in Data.Greskell.PMap

Methods

compare :: PMapLookupException -> PMapLookupException -> Ordering

(<) :: PMapLookupException -> PMapLookupException -> Bool

(<=) :: PMapLookupException -> PMapLookupException -> Bool

(>) :: PMapLookupException -> PMapLookupException -> Bool

(>=) :: PMapLookupException -> PMapLookupException -> Bool

max :: PMapLookupException -> PMapLookupException -> PMapLookupException

min :: PMapLookupException -> PMapLookupException -> PMapLookupException

Show PMapLookupException

Defined in Data.Greskell.PMap

Methods

showsPrec :: Int -> PMapLookupException -> ShowS

show :: PMapLookupException -> String

showList :: [PMapLookupException] -> ShowS

Exception PMapLookupException

Defined in Data.Greskell.PMap

Methods

toException :: PMapLookupException -> SomeException

fromException :: SomeException -> Maybe PMapLookupException

displayException :: PMapLookupException -> String

LabeledP

data LabeledP a

LabeledP is just like P, a Haskell representation of TinkerPop's P class. Unlike P, however, LabeledP keeps a label (AsLabel) inside. It is used in .where step.

Since: 1.2.0.0

Instances

PLike (LabeledP a)

You can construct Greskell (LabeledP a) from AsLabel a.

Defined in Data.Greskell.AsLabel

Associated Types

type PParameter (LabeledP a)

type PParameter (LabeledP a)

Defined in Data.Greskell.AsLabel

type PParameter (LabeledP a) = AsLabel a