Struct MemoryLookup 

pub struct MemoryLookup { /* private fields */ }

An in-memory address lookup system to manually add endpoint addressing information.

Often an application might get endpoint addressing information out-of-band in an application-specific way. EndpointTicket’s are one common way used to achieve this. This addressing information is often only usable for a limited time so needs to be able to be removed again once know it is no longer useful.

This is where the MemoryLookup is useful: it allows applications to add and retract endpoint addressing information that is otherwise out-of-band to iroh.

Examples

use iroh::{
    Endpoint, EndpointAddr, TransportAddr, address_lookup::memory::MemoryLookup,
    endpoint::presets,
};
use iroh_base::SecretKey;

// Create the Address Lookup and endpoint.
let address_lookup = MemoryLookup::new();

let _ep = Endpoint::builder(presets::N0)
    .address_lookup(address_lookup.clone())
    .bind()
    .await?;

// Sometime later add a RelayUrl for our endpoint.
let id = SecretKey::generate(&mut rand::rng()).public();
// You can pass either `EndpointInfo` or `EndpointAddr` to `add_endpoint_info`.
address_lookup.add_endpoint_info(EndpointAddr {
    id,
    addrs: [TransportAddr::Relay("https://example.com".parse()?)]
        .into_iter()
        .collect(),
});

Implementations

impl MemoryLookup

pub const PROVENANCE: &'static str = "memory_lookup"

The provenance string for this Address Lookup implementation.

This is mostly used for debugging information and allows understanding the origin of addressing information used by an iroh Endpoint.

pub fn new() -> Self

Creates a new static Address Lookup instance.

pub fn with_provenance(provenance: &'static str) -> Self

Creates a new Memory Lookup instance with the provided provenance.

The provenance is part of address_lookup::Items returned from Self::resolve. It is mostly used for debugging information and allows understanding the origin of addressing information used by an iroh Endpoint.

pub fn from_endpoint_info( infos: impl IntoIterator<Item = impl Into<EndpointInfo>>, ) -> Self

Creates a Memory Lookup instance from endpoint addresses.

Examples

use std::{net::SocketAddr, str::FromStr};

use iroh::{Endpoint, EndpointAddr, address_lookup::memory::MemoryLookup, endpoint::presets};

// get addrs from somewhere
let addrs = get_addrs();

// create a MemoryLookup from the list of addrs.
let address_lookup = MemoryLookup::from_endpoint_info(addrs);
// create an endpoint with the memory lookup address_lookup
let endpoint = Endpoint::builder(presets::N0)
    .address_lookup(address_lookup)
    .bind()
    .await?;

pub fn set_endpoint_info( &self, endpoint_info: impl Into<EndpointInfo>, ) -> Option<EndpointData>

Sets endpoint addressing information for the given endpoint ID.

This will completely overwrite any existing info for the endpoint.

Returns the EndpointData of the previous entry, or None if there was no previous entry for this endpoint ID.

pub fn add_endpoint_info(&self, endpoint_info: impl Into<EndpointInfo>)

Augments endpoint addressing information for the given endpoint ID.

The provided addressing information is combined with the existing info in the memory lookup. Any new direct addresses are added to those already present while the relay URL is overwritten.

pub fn get_endpoint_info(&self, endpoint_id: EndpointId) -> Option<EndpointInfo>

Returns endpoint addressing information for the given endpoint ID.

pub fn remove_endpoint_info( &self, endpoint_id: EndpointId, ) -> Option<EndpointInfo>

Removes all endpoint addressing information for the given endpoint ID.

Any removed information is returned.

Trait Implementations

impl AddressLookup for MemoryLookup

fn publish(&self, _data: &EndpointData)

Publishes the given EndpointData to the Address Lookup mechanism.

fn resolve( &self, endpoint_id: EndpointId, ) -> Option<BoxStream<Result<Item, Error>>>

Resolves the Item for the given EndpointId.

impl Clone for MemoryLookup

fn clone(&self) -> MemoryLookup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryLookup

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

Formats the value using the given formatter.

impl Default for MemoryLookup

fn default() -> Self

Returns the “default value” for a type.