VISX.FFI

type E a = Either MultipleErrors a

An alias for the Either result of decoding

write :: forall a. WriteForeign a => a -> Foreign

read :: forall a. ReadForeign a => Foreign -> E a

Read a Foreign value to a type

read' :: forall a. ReadForeign a => Foreign -> F a

read_ :: forall a. ReadForeign a => Foreign -> Maybe a

Read a Foreign value to a type, as a Maybe of type

undefined :: Foreign

class ReadForeign a  where

A class for reading foreign values to a type

Members

• readImpl :: Foreign -> F a

Instances

• ReadForeign Foreign
• ReadForeign Char
• ReadForeign Number
• ReadForeign Int
• ReadForeign String
• ReadForeign Boolean
• (ReadForeign a) => ReadForeign (Array a)
• (ReadForeign a) => ReadForeign (Maybe a)
• (ReadForeign a) => ReadForeign (Nullable a)
• (ReadForeign a) => ReadForeign (Object a)
• (RowToList fields fieldList, ReadForeignFields fieldList () fields) => ReadForeign (Record fields)
• (ReadForeign a) => ReadForeign (NonEmptyArray a)

class ReadForeignFields :: RowList Type -> Row Type -> Row Type -> Constraintclass ReadForeignFields (xs :: RowList Type) (from :: Row Type) (to :: Row Type) | xs -> from to where

A class for reading foreign values from properties

Members

• getFields :: Proxy xs -> Foreign -> F (Builder (Record from) (Record to))

Instances

• (IsSymbol name, ReadForeign ty, ReadForeignFields tail from from', Lacks name from', Cons name ty from' to) => ReadForeignFields (Cons name ty tail) from to
• ReadForeignFields Nil () ()

class WriteForeign a  where

Members

• writeImpl :: a -> Foreign

Instances

• WriteForeign Foreign
• WriteForeign String
• WriteForeign Int
• WriteForeign Char
• WriteForeign Number
• WriteForeign Boolean
• WriteForeign JSDate
• (WriteForeign a) => WriteForeign (Array a)
• (WriteForeign a, WriteForeign (Tuple b c)) => WriteForeign (Tuple a (Tuple b c))
• (WriteForeign a, WriteForeign b) => WriteForeign (Tuple a b)
• (WriteForeign a) => WriteForeign (Maybe a)
• (WriteForeign a) => WriteForeign (Nullable a)
• (WriteForeign a) => WriteForeign (Object a)
• (RowToList row rl, WriteForeignFields rl row () to) => WriteForeign (Record row)
• (WriteForeign a) => WriteForeign (NonEmptyArray a)

class WriteForeignFields :: RowList Type -> Row Type -> Row Type -> Row Type -> Constraintclass WriteForeignFields (rl :: RowList Type) row (from :: Row Type) (to :: Row Type) | rl -> row from to where

Members

• writeImplFields :: forall g. g rl -> Record row -> Builder (Record from) (Record to)

Instances

• (IsSymbol name, WriteForeign ty, WriteForeignFields tail row from from', Cons name ty whatever row, Lacks name from', Cons name Foreign from' to) => WriteForeignFields (Cons name ty tail) row from to
• WriteForeignFields Nil row () ()

class Options a b  where

Members

• toOptions :: a -> b

Instances

• (Justifiable (Record a) (Record via), Fillable (Record via) (Record b)) => Options (Record a) (Record b)