Binrep.BLen.Simple

Byte length as a simple pure function, no bells or whistles.

Non-reallocating serializers like store, bytezap or ptr-poker request the expected total byte length when serializing. Thus, they need some way to measure byte length *before* serializing. This is that.

It should be very efficient to calculate serialized byte length for most binrep-compatible Haskell types. If it isn't, consider whether the representation is appropriate for binrep.

Documentation

class BLen a where

Methods

blen :: a -> Int

Instances

(TypeError ENoEmpty :: Constraint) => BLen Void

Defined in Binrep.BLen.Simple

Methods

blen :: Void -> Int

BLen Int16

Defined in Binrep.BLen.Simple

Methods

blen :: Int16 -> Int

BLen Int32

Defined in Binrep.BLen.Simple

Methods

blen :: Int32 -> Int

BLen Int64

Defined in Binrep.BLen.Simple

Methods

blen :: Int64 -> Int

BLen Int8

Defined in Binrep.BLen.Simple

Methods

blen :: Int8 -> Int

BLen Word16

Defined in Binrep.BLen.Simple

Methods

blen :: Word16 -> Int

BLen Word32

Defined in Binrep.BLen.Simple

Methods

blen :: Word32 -> Int

BLen Word64

Defined in Binrep.BLen.Simple

Methods

blen :: Word64 -> Int

BLen Word8

Defined in Binrep.BLen.Simple

Methods

blen :: Word8 -> Int

BLen Write

Defined in Binrep.BLen.Simple

Methods

blen :: Write -> Int

BLen ByteString

Length of a bytestring is fairly obvious.

Defined in Binrep.BLen.Simple

Methods

blen :: ByteString -> Int

BLen ()

Unit type has length 0.

Defined in Binrep.BLen.Simple

Methods

blen :: () -> Int

KnownNat (CBLen a) => BLen (CBLenly a)

Defined in Binrep.BLen.Simple

Methods

blen :: CBLenly a -> Int

BLen a => BLen (NullTerminated a)

Defined in Binrep.Type.NullTerminated

Methods

blen :: NullTerminated a -> Int

BLen a => BLen (Thin a)

Defined in Binrep.Type.Thin

Methods

blen :: Thin a -> Int

BLen a => BLen (Binreply a)

Defined in Binrep.Via

Methods

blen :: Binreply a -> Int

BLen a => BLen [a]

_O(n)_ Sum the length of each element of a list.

Defined in Binrep.BLen.Simple

Methods

blen :: [a] -> Int

(TypeError ENoSum :: Constraint) => BLen (Either a b)

Defined in Binrep.BLen.Simple

Methods

blen :: Either a b -> Int

BLen a => BLen (Endian end a)

Defined in Binrep.Type.Int

Methods

blen :: Endian end a -> Int

KnownNat (Length (MagicBytes a)) => BLen (Magic a)

Defined in Binrep.Type.Magic

Methods

blen :: Magic a -> Int

(Prefix pfx, BLen a, BLen pfx) => BLen (SizePrefixed pfx a)

Defined in Binrep.Type.Prefix.Size

Methods

blen :: SizePrefixed pfx a -> Int

KnownNat n => BLen (Sized n a)

Defined in Binrep.Type.Sized

Methods

blen :: Sized n a -> Int

(BLen l, BLen r) => BLen (l, r)

Sum tuples.

Defined in Binrep.BLen.Simple

Methods

blen :: (l, r) -> Int

(Prefix pfx, Foldable f, BLen pfx, BLen (f a)) => BLen (CountPrefixed pfx f a)

Defined in Binrep.Type.Prefix.Count

Methods

blen :: CountPrefixed pfx f a -> Int

newtype BLen' a

Constructors

BLen'

Fields

• getBLen' :: a

Instances

Num a => Monoid (BLen' a)

Defined in Binrep.BLen.Simple

Methods

mempty :: BLen' a

mappend :: BLen' a -> BLen' a -> BLen' a

mconcat :: [BLen' a] -> BLen' a

Num a => Semigroup (BLen' a)

Defined in Binrep.BLen.Simple

Methods

(<>) :: BLen' a -> BLen' a -> BLen' a

sconcat :: NonEmpty (BLen' a) -> BLen' a

stimes :: Integral b => b -> BLen' a -> BLen' a

GenericFoldMap (BLen' Int)

Defined in Binrep.BLen.Simple

Associated Types

type GenericFoldMapC (BLen' Int) a

Methods

genericFoldMapF :: GenericFoldMapC (BLen' Int) a => a -> BLen' Int

type GenericFoldMapC (BLen' Int) a

Defined in Binrep.BLen.Simple

type GenericFoldMapC (BLen' Int) a = BLen a

blenGenericNonSum :: forall {cd} {f} {asserts} a. (Generic a, Rep a ~ D1 cd f, GFoldMapNonSum (BLen' Int) f, asserts ~ '['NoEmpty, 'NoSum], ApplyGCAsserts asserts f) => a -> Int

Measure the byte length of a term of the non-sum type a via its Generic instance.

blenGenericSum :: forall {cd} {f} {asserts} a. (Generic a, Rep a ~ D1 cd f, GFoldMapSum 'SumOnly (BLen' Int) f, asserts ~ '['NoEmpty, 'NeedSum], ApplyGCAsserts asserts f) => (String -> Int) -> a -> Int

Measure the byte length of a term of the sum type a via its Generic instance.

You must provide a function to obtain the byte length for the prefix tag, via inspecting the reified constructor names. This is regrettably inefficient. Alas. Do write your own instance if you want better performance!

newtype CBLenly a

Deriving via wrapper for types which may derive a BLen instance through an existing IsCBLen instance.

Examples of such types include machine integers, and explicitly-sized types (e.g. Binrep.Type.Sized).

Constructors

CBLenly

Fields

• unCBLenly :: a

Instances

KnownNat (CBLen a) => BLen (CBLenly a)

Defined in Binrep.BLen.Simple

Methods

blen :: CBLenly a -> Int

cblen :: forall a n. (n ~ CBLen a, KnownNat n) => Int

Reify a type's constant byte length to the term level.