multiaddr.codecs package

Submodules

multiaddr.codecs.cid module

class multiaddr.codecs.cid.Codec[source]

Bases: CodecBase

IS_PATH: bool = False
SIZE: int = -1
to_bytes(proto, string: str) → bytes[source]

Convert a CID string to its binary representation.

to_string(proto, buf: bytes) → str[source]

Convert a binary CID to its string representation.

multiaddr.codecs.domain module

class multiaddr.codecs.domain.Codec[source]

Bases: CodecBase

IS_PATH: bool = False
SIZE: int = -1
to_bytes(proto, string: str) → bytes[source]

Convert a domain name string to its binary representation (UTF-8), validating with IDNA.

to_string(proto, buf: bytes) → str[source]

Convert a binary domain name to its string representation (UTF-8), validating with IDNA.

multiaddr.codecs.domain.to_bytes(proto, string)[source]
multiaddr.codecs.domain.to_string(proto, buf)[source]

multiaddr.codecs.fspath module

class multiaddr.codecs.fspath.Codec[source]

Bases: CodecBase

IS_PATH: bool = True
SIZE: int = -1
to_bytes(proto, string: str) → bytes[source]

Convert a filesystem path to its binary representation.

to_string(proto, buf: bytes) → str[source]

Convert a binary filesystem path to its string representation.

multiaddr.codecs.ip4 module

class multiaddr.codecs.ip4.Codec[source]

Bases: CodecBase

IS_PATH: bool = False
SIZE: int = 32
to_bytes(proto, string)[source]
to_string(proto, buf)[source]

multiaddr.codecs.ip6 module

class multiaddr.codecs.ip6.Codec[source]

Bases: CodecBase

IS_PATH: bool = False
SIZE: int = 128
to_bytes(proto, string)[source]
to_string(proto, buf)[source]

multiaddr.codecs.onion module

class multiaddr.codecs.onion.Codec[source]

Bases: CodecBase

IS_PATH: bool = False
SIZE: int = 96
to_bytes(proto, string)[source]
to_string(proto, buf)[source]

multiaddr.codecs.onion3 module

class multiaddr.codecs.onion3.Codec[source]

Bases: CodecBase

IS_PATH: bool = False
SIZE: int = 296
to_bytes(proto, string)[source]
to_string(proto, buf)[source]

multiaddr.codecs.uint16be module

class multiaddr.codecs.uint16be.Codec[source]

Bases: CodecBase

IS_PATH: bool = False
SIZE: int = 16
to_bytes(proto, string)[source]
to_string(proto, buf)[source]

multiaddr.codecs.utf8 module

class multiaddr.codecs.utf8.Codec[source]

Bases: CodecBase

IS_PATH: bool = False
SIZE: int = 0
to_bytes(proto, string: str) → bytes[source]

Convert a UTF-8 string to its binary representation.

to_string(proto, buf: bytes) → str[source]

Convert a binary UTF-8 string to its string representation.

Module contents

class multiaddr.codecs.CodecBase[source]

Bases: object

IS_PATH: bool
SIZE: int
to_bytes(proto: Any, string: str) → bytes[source]
to_string(proto: Any, buf: bytes) → str[source]
class multiaddr.codecs.NoneCodec[source]

Bases: CodecBase

IS_PATH: bool = False
SIZE: int = 0
to_bytes(proto: Any, string: str) → bytes[source]
to_string(proto: Any, buf: bytes) → str[source]
multiaddr.codecs.codec_by_name(name: str | None) → CodecBase[source]