API Reference

multicodec.add_prefix(multicodec: str, bytes_: bytes) → bytes

Adds multicodec prefix to the given bytes input

Parameters:

• multicodec (str) – multicodec to use for prefixing

• bytes (bytes) – data to prefix

Returns:

prefixed byte data

Return type:

bytes

multicodec.remove_prefix(bytes_: bytes) → bytes

Removes prefix from a prefixed data

Parameters:

bytes (bytes) – multicodec prefixed data bytes

Returns:

prefix removed data bytes

Return type:

bytes

multicodec.get_codec(bytes_: bytes) → str

Gets the codec used for prefix the multicodec prefixed data

Parameters:

bytes (bytes) – multicodec prefixed data bytes

Returns:

name of the multicodec used to prefix

Return type:

str

multicodec.get_prefix(multicodec: str) → bytes

Returns prefix for a given multicodec

Parameters:

multicodec (str) – multicodec codec name

Returns:

the prefix for the given multicodec

Return type:

bytes

Raises:

ValueError – if an invalid multicodec name is provided

multicodec.is_codec(name: str) → bool

Check if the codec is a valid codec or not

Parameters:

name (str) – name of the codec

Returns:

if the codec is valid or not

Return type:

bool

multicodec.extract_prefix(bytes_: bytes) → int

Extracts the prefix from multicodec prefixed data

Parameters:

bytes (bytes) – multicodec prefixed data

Returns:

prefix for the prefixed data

Return type:

int

Raises:

ValueError – when incorrect varint is provided