pub struct Enr<K: EnrKey> { /* private fields */ }Expand description
The ENR, allowing for arbitrary signing algorithms.
This struct will always have a valid signature, known public key type, sequence number and NodeId. All other parameters are variable/optional.
Implementations
sourceimpl<K: EnrKey> Enr<K>
impl<K: EnrKey> Enr<K>
sourcepub fn get(&self, key: impl AsRef<[u8]>) -> Option<&[u8]>
pub fn get(&self, key: impl AsRef<[u8]>) -> Option<&[u8]>
Reads a custom key from the record if it exists.
sourcepub fn get_raw_rlp(&self, key: impl AsRef<[u8]>) -> Option<&[u8]>
pub fn get_raw_rlp(&self, key: impl AsRef<[u8]>) -> Option<&[u8]>
Reads a custom key from the record if it exists as raw RLP bytes.
sourcepub fn iter(&self) -> impl Iterator<Item = (&Vec<u8>, &[u8])>
pub fn iter(&self) -> impl Iterator<Item = (&Vec<u8>, &[u8])>
Returns an iterator over all key/value pairs in the ENR.
sourcepub fn ip4(&self) -> Option<Ipv4Addr>
pub fn ip4(&self) -> Option<Ipv4Addr>
Returns the IPv4 address of the ENR record if it is defined.
sourcepub fn ip6(&self) -> Option<Ipv6Addr>
pub fn ip6(&self) -> Option<Ipv6Addr>
Returns the IPv6 address of the ENR record if it is defined.
sourcepub fn udp4_socket(&self) -> Option<SocketAddrV4>
pub fn udp4_socket(&self) -> Option<SocketAddrV4>
Provides a socket (based on the UDP port), if the IPv4 and UDP fields are specified.
sourcepub fn udp6_socket(&self) -> Option<SocketAddrV6>
pub fn udp6_socket(&self) -> Option<SocketAddrV6>
Provides a socket (based on the UDP port), if the IPv6 and UDP fields are specified.
sourcepub fn tcp4_socket(&self) -> Option<SocketAddrV4>
pub fn tcp4_socket(&self) -> Option<SocketAddrV4>
Provides a socket (based on the TCP port), if the IP and TCP fields are specified.
sourcepub fn tcp6_socket(&self) -> Option<SocketAddrV6>
pub fn tcp6_socket(&self) -> Option<SocketAddrV6>
Provides a socket (based on the TCP port), if the IPv6 and TCP6 fields are specified.
sourcepub fn signature(&self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]
pub fn signature(&self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]
The signature of the ENR record.
sourcepub fn public_key(&self) -> K::PublicKey
pub fn public_key(&self) -> K::PublicKey
Returns the public key of the ENR record.
sourcepub fn to_base64(&self) -> String
pub fn to_base64(&self) -> String
Provides the URL-safe base64 encoded “text” version of the ENR prefixed by “enr:”.
sourcepub fn set_seq(&mut self, seq: u64, key: &K) -> Result<(), EnrError>
pub fn set_seq(&mut self, seq: u64, key: &K) -> Result<(), EnrError>
Allows setting the sequence number to an arbitrary value.
sourcepub fn insert(
&mut self,
key: impl AsRef<[u8]>,
value: &[u8],
enr_key: &K
) -> Result<Option<Bytes>, EnrError>
pub fn insert(
&mut self,
key: impl AsRef<[u8]>,
value: &[u8],
enr_key: &K
) -> Result<Option<Bytes>, 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 as rlp encoded bytes in the record if it exists.
sourcepub fn insert_raw_rlp(
&mut self,
key: impl AsRef<[u8]>,
value: Bytes,
enr_key: &K
) -> Result<Option<Bytes>, EnrError>
pub fn insert_raw_rlp(
&mut self,
key: impl AsRef<[u8]>,
value: Bytes,
enr_key: &K
) -> Result<Option<Bytes>, EnrError>
Adds or modifies a key/value to the ENR record. A EnrKey is required to re-sign the record once
modified. The value here is interpreted as raw RLP data.
Returns the previous value as rlp encoded bytes in the record if it exists.
sourcepub fn set_ip(&mut self, ip: IpAddr, key: &K) -> Result<Option<IpAddr>, EnrError>
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.
sourcepub fn set_udp4(&mut self, udp: u16, key: &K) -> Result<Option<u16>, EnrError>
pub fn set_udp4(&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.
sourcepub fn set_udp6(&mut self, udp: u16, key: &K) -> Result<Option<u16>, EnrError>
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.
sourcepub fn set_tcp4(&mut self, tcp: u16, key: &K) -> Result<Option<u16>, EnrError>
pub fn set_tcp4(&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.
sourcepub fn set_tcp6(&mut self, tcp: u16, key: &K) -> Result<Option<u16>, EnrError>
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.
sourcepub fn set_udp_socket(
&mut self,
socket: SocketAddr,
key: &K
) -> Result<(), EnrError>
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.
sourcepub fn set_tcp_socket(
&mut self,
socket: SocketAddr,
key: &K
) -> Result<(), EnrError>
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.
sourcepub fn remove_insert<'a>(
&mut self,
remove_keys: impl Iterator<Item = impl AsRef<[u8]>>,
insert_key_values: impl Iterator<Item = (impl AsRef<[u8]>, &'a [u8])>,
enr_key: &K
) -> Result<(Vec<Option<Bytes>>, Vec<Option<Bytes>>), EnrError>
pub fn remove_insert<'a>(
&mut self,
remove_keys: impl Iterator<Item = impl AsRef<[u8]>>,
insert_key_values: impl Iterator<Item = (impl AsRef<[u8]>, &'a [u8])>,
enr_key: &K
) -> Result<(Vec<Option<Bytes>>, Vec<Option<Bytes>>), EnrError>
Removes key/value mappings and adds or overwrites key/value mappings to the ENR record as
one sequence number update. An EnrKey is required to re-sign the record once modified.
Reverts whole ENR record on error.
Returns the previous values as rlp encoded bytes if they exist for the removed and added/ overwritten keys.