Struct enr::Enr

pub struct Enr<K: EnrKey> { /* fields omitted */ }

The ENR, allowing for arbitrary signing algorithms. The default signing algorithm is secp256k1 using the libsecp256k1 library.

This struct will always have a valid signature, known public key type, sequence number and NodeId. All other parameters are variable/optional.

Implementations

impl<K: EnrKey> Enr<K>

#[must_use]pub fn node_id(&self) -> NodeId

The NodeId for the record.

#[must_use]pub fn seq(&self) -> u64

The current sequence number of the ENR record.

pub fn get(&self, key: impl Into<String>) -> Option<&Vec<u8>>

Reads a custom key from the record if it exists.

pub fn iter(&self) -> impl Iterator<Item = (&String, &Vec<u8>)>

Returns an iterator over all key/value pairs in the ENR.

#[must_use]pub fn ip(&self) -> Option<Ipv4Addr>

Returns the IPv4 address of the ENR record if it is defined.

#[must_use]pub fn ip6(&self) -> Option<Ipv6Addr>

Returns the IPv6 address of the ENR record if it is defined.

#[must_use]pub fn id(&self) -> Option<String>

The id of ENR record if it is defined.

#[must_use]pub fn tcp(&self) -> Option<u16>

The TCP port of ENR record if it is defined.

#[must_use]pub fn tcp6(&self) -> Option<u16>

The IPv6-specific TCP port of ENR record if it is defined.

#[must_use]pub fn udp(&self) -> Option<u16>

The UDP port of ENR record if it is defined.

#[must_use]pub fn udp6(&self) -> Option<u16>

The IPv6-specific UDP port of ENR record if it is defined.

#[must_use]pub fn udp_socket(&self) -> Option<SocketAddr>

Provides a socket (based on the UDP port), if the IP and UDP fields are specified.

#[must_use]pub fn tcp_socket(&self) -> Option<SocketAddr>

Provides a socket (based on the TCP port), if the IP and UDP fields are specified.

#[must_use]pub fn signature(&self) -> &[u8]

The signature of the ENR record.

#[must_use]pub fn public_key(&self) -> K::PublicKey

Returns the public key of the ENR record.

#[must_use]pub fn verify(&self) -> bool

Verify the signature of the ENR record.

#[must_use]pub fn encode(&self) -> Vec<u8>

RLP encodes the ENR into a byte array.

#[must_use]pub fn to_base64(&self) -> String

Provides the URL-safe base64 encoded "text" version of the ENR prefixed by "enr:".

#[must_use]pub fn size(&self) -> usize

Returns the current size of the ENR.

pub fn set_seq(&mut self, seq: u64, key: &K) -> Result<(), EnrError>

Allows setting the sequence number to an arbitrary value.

pub fn insert(
    &mut self,
    key: &str,
    value: Vec<u8>,
    enr_key: &K
) -> Result<Option<Vec<u8>>, EnrError>

Adds or modifies a key/value to the ENR record. A EnrKey is required to re-sign the record once modified.

Returns the previous value in the record if it exists.

pub fn set_ip(
    &mut self,
    ip: IpAddr,
    key: &K
) -> Result<Option<IpAddr>, EnrError>

Sets the ip field of the ENR. Returns any pre-existing IP address in the record.

pub fn set_udp(&mut self, udp: u16, key: &K) -> Result<Option<u16>, EnrError>

Sets the udp field of the ENR. Returns any pre-existing UDP port in the record.

pub fn set_udp6(&mut self, udp: u16, key: &K) -> Result<Option<u16>, EnrError>

Sets the udp6 field of the ENR. Returns any pre-existing UDP port in the record.

pub fn set_tcp(&mut self, tcp: u16, key: &K) -> Result<Option<u16>, EnrError>

Sets the tcp field of the ENR. Returns any pre-existing tcp port in the record.

pub fn set_tcp6(&mut self, tcp: u16, key: &K) -> Result<Option<u16>, EnrError>

Sets the tcp6 field of the ENR. Returns any pre-existing tcp6 port in the record.

pub fn set_udp_socket(
    &mut self,
    socket: SocketAddr,
    key: &K
) -> Result<(), EnrError>

Sets the IP and UDP port in a single update with a single increment in sequence number.

pub fn set_tcp_socket(
    &mut self,
    socket: SocketAddr,
    key: &K
) -> Result<(), EnrError>

Sets the IP and TCP port in a single update with a single increment in sequence number.

pub fn set_public_key(
    &mut self,
    public_key: &K::PublicKey,
    key: &K
) -> Result<(), EnrError>

Sets a new public key for the record.

Trait Implementations

impl<K: EnrKey> Clone for Enr<K>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K: EnrKey> Debug for Enr<K>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<K: EnrKey> Decodable for Enr<K>

fn decode(rlp: &Rlp) -> Result<Self, DecoderError>

Decode a value from RLP bytes

impl<'de, K: EnrKey> Deserialize<'de> for Enr<K>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<K: EnrKey> Display for Enr<K>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<K: EnrKey> Encodable for Enr<K>

fn rlp_append(&self, s: &mut RlpStream)

Append a value to the stream

fn rlp_bytes(&self) -> Vec<u8>

Get rlp-encoded bytes for this instance

impl<K: Eq + EnrKey> Eq for Enr<K>

impl<'_, T: EnrKey> From<&'_ Enr<T>> for NodeId

fn from(enr: &Enr<T>) -> Self

Performs the conversion.

impl<T: EnrKey> From<Enr<T>> for NodeId

fn from(enr: Enr<T>) -> Self

Performs the conversion.

impl<K: EnrKey> FromStr for Enr<K>

Convert a URL-SAFE base64 encoded ENR into an ENR.

type Err = String

The associated error which can be returned from parsing.

fn from_str(base64_string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<K: EnrKey> PartialEq<Enr<K>> for Enr<K>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<K: EnrKey> Serialize for Enr<K>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<K: EnrKey> StructuralEq for Enr<K>