clj.intracel.serde.interface

Liking cljdoc? Tell your friends :D

Clojure only.

big-decimal-serde
big-int-serde
byte-serde
double-serde
float-serde
int-serde
long-serde
nippy-serde
short-serde
string-serde
u128-int-serde

The SerDe interface is used to move data in and out of the KV-Store. Most of these are usable for both key and value SerDes. For SerDes like big-int-serde, big-decimal-serde, nippy-serde, and string-serde it is recommended to use caution when serializing keys as there is a 511 byte limit in the underlying LMDB embedded database. To ease concerns a 511 byte limit supports most of the hashing algorithms easily:

MD5 - 16 bytes
RIPEMD - 20 bytes
SHA256 - 32 bytes
SHA384 - 48 bytes
SHA512 - 64 bytes
WHIRLPOOL - 64 bytes
xxhash - 8 bytes by default but a 128-bit xxhash is 16 bytes

The SerDe interface is used to move data in and out of the KV-Store.
Most of these are usable for both key and value SerDes.
For SerDes like `big-int-serde`, `big-decimal-serde`, `nippy-serde`, and `string-serde` 
it is recommended to use caution when serializing keys as there is a 511 byte limit
in the underlying LMDB embedded database.
To ease concerns a 511 byte limit supports most of the hashing algorithms easily:
* MD5 - 16 bytes
* RIPEMD - 20 bytes
* SHA256 - 32 bytes
* SHA384 - 48 bytes
* SHA512 - 64 bytes
* WHIRLPOOL - 64 bytes
* xxhash - 8 bytes by default but a 128-bit xxhash is 16 bytes

raw docstring

big-decimal-serde^clj

(big-decimal-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle large, high-precision fractions represented as java.math.BigDecimal.

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process java.math.BigDecimals

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle large, high-precision fractions represented as `java.math.BigDecimal`.

Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process `java.math.BigDecimal`s

source raw docstring

big-int-serde^clj

(big-int-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle large integers represented as java.math.BigInteger.

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process java.math.BigIntegerss

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle large integers represented as `java.math.BigInteger`.
 
Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process `java.math.BigIntegers`s

source raw docstring

byte-serde^clj

(byte-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle a single 8-bit signed integer. Min: -128 Max: 127

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process a single 8-bit integer.

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle a single 8-bit signed integer.
Min: -128
Max: 127

Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process a single 8-bit integer.

source raw docstring

double-serde^clj

(double-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle a 64-bit signed integer. Min: -9223372036854775808 Max: 9223372036854775807

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process a 64-bit signed integer.

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle a 64-bit signed integer.
Min: -9223372036854775808
Max: 9223372036854775807
  
Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process a 64-bit signed integer.

source raw docstring

float-serde^clj

(float-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle a 32-bit signed floating point number. Min: 1.4E-45 Max: 3.4028235E38

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process a 32-bit signed floating point number.

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle a 32-bit signed floating point number.
Min: 1.4E-45
Max: 3.4028235E38
    
Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process a 32-bit signed floating point number.

source raw docstring

int-serde^clj

(int-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle a 32-bit signed integer. Min: -2147483648 Max: 2147483647

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process a 32-bit signed integer.

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle a 32-bit signed integer.
Min: -2147483648
Max: 2147483647
      
Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process a 32-bit signed integer.

source raw docstring

long-serde^clj

(long-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle a 64-bit signed integer. Min: -9223372036854775808 Max: 9223372036854775807

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process a 64-bit signed integer.

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle a 64-bit signed integer.
Min: -9223372036854775808
Max: 9223372036854775807
      
Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process a 64-bit signed integer.

source raw docstring

nippy-serde^clj

(nippy-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle EDN formatted data and convert it to/from nippy.

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process valid EDN formatted data.

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle EDN formatted data and convert it to/from nippy.
      
Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process valid EDN formatted data.

source raw docstring

short-serde^clj

(short-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle a 16-bit signed integer. Min: -32768 Max: 32767

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process a 16-bit signed integer.

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle a 16-bit signed integer.
Min: -32768
Max: 32767
      
Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process a 16-bit signed integer.

source raw docstring

string-serde^clj

(string-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle a Clojure string.

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process a Clojure string.

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle a Clojure string.
        
Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process a Clojure string.

source raw docstring

u128-int-serde^clj

(u128-int-serde)

Creates a clj.intracel.api.interface.protocols/KVSerde that can handle a 128-bit unsigned integer.

Returns: A [[clj.intracel.api.protocols/KVSerde]] that can process a 128-bit unsigned integer.

Creates a [[clj.intracel.api.interface.protocols/KVSerde]] that can handle a 128-bit unsigned integer.
          
Returns: 
A [[clj.intracel.api.protocols/KVSerde]] that can process a 128-bit unsigned integer.

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close