Data.Sext.Class

Use this only if you need to make some type Sextable.

Documentation

class Sextable a where

Class of types which can be assigned a type-level length.

Minimal complete definition

unsafeCreate, unwrap, length, append, replicate, map, take, drop

Associated Types

data Sext (i :: Nat) a

Data family which wraps values of the underlying type giving them a type-level length. Sext 6 t means a value of type t of length 6.

type Elem a

Basic element type. For Sextable [a], this is a.

Methods

unsafeCreate :: a -> Sext i a

Simply wrap a value in a Sext as is, assuming any length.

For example, an expression like

unsafeCreate "somestring" :: Sext 50 String

will typecheck, although the stored length information will not match actual string size. This may result in wrong behaviour of all functions defined for Sext.

Use it only when you know what you're doing.

When implementing new Sextable instances, code this to simply apply the constructor of Sext.

unwrap :: Sext i a -> a

Forget type-level length, obtaining the underlying value.

length :: a -> Int

append :: a -> a -> a

replicate :: Int -> Elem a -> a

map :: (Elem a -> Elem a) -> a -> a

take :: Int -> a -> a

drop :: Int -> a -> a

Instances

Sextable ShortByteString

Sextable instance for ShortByteString uses intermediate ByteStrings (pinned) for all modification operations.

Associated Types

data Sext (i :: Nat) ShortByteString :: *

type Elem ShortByteString :: *

Methods

unsafeCreate :: ShortByteString -> Sext i ShortByteString

unwrap :: Sext i ShortByteString -> ShortByteString

length :: ShortByteString -> Int

append :: ShortByteString -> ShortByteString -> ShortByteString

replicate :: Int -> Elem ShortByteString -> ShortByteString

map :: (Elem ShortByteString -> Elem ShortByteString) -> ShortByteString -> ShortByteString

take :: Int -> ShortByteString -> ShortByteString

drop :: Int -> ShortByteString -> ShortByteString

Sextable ByteString

Associated Types

data Sext (i :: Nat) ByteString :: *

type Elem ByteString :: *

Methods

unsafeCreate :: ByteString -> Sext i ByteString

unwrap :: Sext i ByteString -> ByteString

length :: ByteString -> Int

append :: ByteString -> ByteString -> ByteString

replicate :: Int -> Elem ByteString -> ByteString

map :: (Elem ByteString -> Elem ByteString) -> ByteString -> ByteString

take :: Int -> ByteString -> ByteString

drop :: Int -> ByteString -> ByteString

Sextable Text

Associated Types

data Sext (i :: Nat) Text :: *

type Elem Text :: *

Methods

unsafeCreate :: Text -> Sext i Text

unwrap :: Sext i Text -> Text

length :: Text -> Int

append :: Text -> Text -> Text

replicate :: Int -> Elem Text -> Text

map :: (Elem Text -> Elem Text) -> Text -> Text

take :: Int -> Text -> Text

drop :: Int -> Text -> Text

Sextable [a]

Associated Types

data Sext (i :: Nat) [a] :: *

type Elem [a] :: *

Methods

unsafeCreate :: [a] -> Sext i [a]

unwrap :: Sext i [a] -> [a]

length :: [a] -> Int

append :: [a] -> [a] -> [a]

replicate :: Int -> Elem [a] -> [a]

map :: (Elem [a] -> Elem [a]) -> [a] -> [a]

take :: Int -> [a] -> [a]

drop :: Int -> [a] -> [a]

Sextable (Vector a)

Associated Types

data Sext (i :: Nat) (Vector a) :: *

type Elem (Vector a) :: *

Methods

unsafeCreate :: Vector a -> Sext i (Vector a)

unwrap :: Sext i (Vector a) -> Vector a

length :: Vector a -> Int

append :: Vector a -> Vector a -> Vector a

replicate :: Int -> Elem (Vector a) -> Vector a

map :: (Elem (Vector a) -> Elem (Vector a)) -> Vector a -> Vector a

take :: Int -> Vector a -> Vector a

drop :: Int -> Vector a -> Vector a