Network.ONCRPC.XDR.Array

Various kinds of arrays (lists, vectors, bytestrings) with statically aserted length constraints encoded in their type.

Documentation

class KnownNat (n :: Nat)

This class gives the integer associated with a type-level natural. There are instances of the class for every concrete literal: 0, 1, 2, etc.

Since: 4.7.0.0

Minimal complete definition

natSing

class KnownOrdering (o :: Ordering)

Minimal complete definition

orderingVal

Instances

KnownOrdering LT

Methods

orderingVal :: proxy LT -> Ordering

KnownOrdering EQ

Methods

orderingVal :: proxy EQ -> Ordering

KnownOrdering GT

Methods

orderingVal :: proxy GT -> Ordering

data LengthArray (o :: Ordering) (n :: Nat) a

Assertion that the contained array satisfies compareLength a n = o

Instances

Eq a => Eq (LengthArray o n a)

Methods

(==) :: LengthArray o n a -> LengthArray o n a -> Bool

(/=) :: LengthArray o n a -> LengthArray o n a -> Bool

Ord a => Ord (LengthArray o n a)

Methods

compare :: LengthArray o n a -> LengthArray o n a -> Ordering

(<) :: LengthArray o n a -> LengthArray o n a -> Bool

(<=) :: LengthArray o n a -> LengthArray o n a -> Bool

(>) :: LengthArray o n a -> LengthArray o n a -> Bool

(>=) :: LengthArray o n a -> LengthArray o n a -> Bool

max :: LengthArray o n a -> LengthArray o n a -> LengthArray o n a

min :: LengthArray o n a -> LengthArray o n a -> LengthArray o n a

Show a => Show (LengthArray o n a)

Methods

showsPrec :: Int -> LengthArray o n a -> ShowS

show :: LengthArray o n a -> String

showList :: [LengthArray o n a] -> ShowS

(KnownOrdering o, KnownNat n, IsString a, HasLength a) => IsString (LengthArray o n a)

Methods

fromString :: String -> LengthArray o n a

KnownNat n => XDR (LengthArray LT n ByteString)

Methods

xdrType :: LengthArray LT n ByteString -> String

xdrPut :: LengthArray LT n ByteString -> Put

xdrGet :: Get (LengthArray LT n ByteString)

(KnownNat n, XDR a) => XDR (LengthArray LT n (Vector a))

Methods

xdrType :: LengthArray LT n (Vector a) -> String

xdrPut :: LengthArray LT n (Vector a) -> Put

xdrGet :: Get (LengthArray LT n (Vector a))

(KnownNat n, XDR a) => XDR (LengthArray LT n [a])

Methods

xdrType :: LengthArray LT n [a] -> String

xdrPut :: LengthArray LT n [a] -> Put

xdrGet :: Get (LengthArray LT n [a])

KnownNat n => XDR (LengthArray EQ n ByteString)

Methods

xdrType :: LengthArray EQ n ByteString -> String

xdrPut :: LengthArray EQ n ByteString -> Put

xdrGet :: Get (LengthArray EQ n ByteString)

(KnownNat n, XDR a) => XDR (LengthArray EQ n (Vector a))

Methods

xdrType :: LengthArray EQ n (Vector a) -> String

xdrPut :: LengthArray EQ n (Vector a) -> Put

xdrGet :: Get (LengthArray EQ n (Vector a))

(KnownNat n, XDR a) => XDR (LengthArray EQ n [a])

Methods

xdrType :: LengthArray EQ n [a] -> String

xdrPut :: LengthArray EQ n [a] -> Put

xdrGet :: Get (LengthArray EQ n [a])

type FixedLengthArray n a = LengthArray EQ n a

Assertion that the contained array is exactly a static length

fixedLengthArrayLength :: KnownNat n => LengthArray EQ n a -> Int

Static length of a FixedLengthArray

type BoundedLengthArray n a = LengthArray LT (n + 1) a

Assertion that the contained array is at most a static length (inclusive)

boundedLengthArrayBound :: KnownNat n => LengthArray LT n a -> Int

Static upper-bound (inclusive) of a BoundedLengthArray

unLengthArray :: LengthArray o n a -> a

unsafeLengthArray :: a -> LengthArray o n a

Unsafely create a LengthArray without checking the length bound assertion. May cause unpredictable behavior if the bound does not hold.

lengthArray :: forall o n a. (KnownOrdering o, KnownNat n, HasLength a) => a -> Maybe (LengthArray o n a)

Safely create a LengthArray out of an array if it conforms to the static length assertion.

lengthArray' :: forall o n a. (KnownOrdering o, KnownNat n, HasLength a) => a -> LengthArray o n a

Create a LengthArray or runtime error if the assertion fails: fromMaybe undefined . lengthArray

boundLengthArray :: (KnownNat n, Array a) => a -> LengthArray LT n a

Create a BoundedLengthArray by trimming the given array if necessary.

boundLengthArrayFromList :: (KnownNat n, Array a) => [Elem a] -> LengthArray LT n a

Create a BoundedLengthArray by trimming the given array if necessary.

padLengthArray :: (KnownNat n, Array a) => a -> Elem a -> LengthArray EQ n a

Create a FixedLengthArray by trimming or padding (on the right) as necessary.

constLengthArray :: (KnownNat n, Array a) => Elem a -> LengthArray EQ n a

Create a FixedLengthArray filled with the same value.

emptyFixedLengthArray :: Array a => LengthArray EQ 0 a

An empty FixedLengthArray.

emptyBoundedLengthArray :: (CmpNat 0 n ~ LT, Array a) => LengthArray LT n a

An empty BoundedLengthArray.

expandBoundedLengthArray :: CmpNat n m ~ LT => LengthArray LT n a -> LengthArray LT m a

Grow the bound of a BoundedLengthArray.

boundFixedLengthArray :: CmpNat n m ~ LT => LengthArray EQ n a -> LengthArray LT m a

Convert a FixedLengthArray to a BoundedLengthArray.

appendLengthArray :: Monoid a => LengthArray o n a -> LengthArray o m a -> LengthArray o (n + m) a

Append to two LengthArrays.

fromLengthList :: Array a => LengthArray o n [Elem a] -> LengthArray o n a