Data.Function.Sub

data Sub :: Type -> Type -> Type

A function that will not copy or discard references to its argument, unless it is allowed to by a Clone or Drop instance.

Currently there is no syntax for Sub literals. You can create Sub values only through combinators (mainly <<<) and the FFI (normal pure unary JavaScript function).

Instances

• Semigroupoid Sub
• Category Sub

Operator alias for Data.Function.Sub.Sub (right-associative / precedence 4)

runShared :: forall b a. Shared a => Shared b => (a -* b) -> a -> b

Run a function over shared values.

liftShared :: forall b a. Shared a => Shared b => (a -> b) -> a -* b

Lift a function over shared values into a Sub.

class Clone a  where

Values which can be cloned. Instances of Clone must satisfy the following laws:

• Clone: fst' <<< clone = snd' <<< clone = id

Members

• clone :: a -* (Tuple a a)

Instances

• Clone Void
• Clone Unit
• Clone Boolean
• Clone Char
• Clone Int
• Clone Number
• Clone String
• (Shared a) => Clone (Array a)
• (Clone a, Clone b) => Clone (Tuple a b)
• Clone (Borrow a)

class Drop a  where

Values which can be dropped.

Members

• drop :: a -* Unit

Instances

• Drop Void
• Drop Unit
• Drop Boolean
• Drop Char
• Drop Int
• Drop Number
• Drop String
• (Shared a) => Drop (Array a)
• (Drop a, Drop b) => Drop (Tuple a b)
• Drop (Borrow a)

class (Clone a, Drop a) <= Shared a 

Values for which multiple live references can exist. Clone and Drop instances may be no-ops.

Instances

• Shared Void
• Shared Unit
• Shared Boolean
• Shared Char
• Shared Int
• Shared Number
• Shared String
• (Shared a) => Shared (Array a)
• (Shared a, Shared b) => Shared (Tuple a b)
• (Shared a) => Shared (Borrow a)

unsafeClone :: forall a. a -* (Tuple a a)

Unsafely clone a value.

unsafeDrop :: forall a. a -* Unit

Unsafely drop a value.

data Borrow :: Type -> Type

A Borrow is a reference to a value. When a borrow to a value is live, the value cannot be accessed unless it is Shared. Some functions take borrows to avoid inconvenient tupling.

Instances

• Clone (Borrow a)
• Drop (Borrow a)
• (Shared a) => Shared (Borrow a)

borrow :: forall b a. Shared b => ((Borrow a) -* b) -> a -* (Tuple a b)

Borrow a value during the execution of a function.