Struct I2pConfig 

pub struct I2pConfig { /* private fields */ }

Configuration for publishing an I2P eepsite via Server::serve_i2p_config.

See the module docs for a full example, and — importantly — for the forbid(unsafe_code) disclosure that applies to this whole feature.

Implementations

impl I2pConfig

pub fn new(nickname: impl Into<String>) -> Self

Creates a new configuration for a service published under nickname. nickname also seeds libi2pd’s own default data directory name (its router keys/netDb cache, separate from this eepsite’s own persistent destination keys — see data_dir).

Defaults: plaintext only (see the module docs for why TLS defaults off here, unlike Tor’s OnionConfig), no on_ready hook, destination keys stored under ./.tachyon-i2p/<nickname>.keys relative to the current working directory, SigType::default for the identity’s signature algorithm (only used the first time this destination’s keys are generated — see signature_type), and no explicit crypto_type override — which means the destination publishes libi2pd’s own automatic hybrid encryption set rather than a single fixed algorithm; see crypto_type’s docs before assuming a specific one is always used.

pub fn data_dir(self, dir: impl Into<PathBuf>) -> Self

Overrides the directory this eepsite’s persistent destination keys file is stored under (as <data_dir>/<nickname>.keys). Reusing the same directory (and nickname) across restarts keeps the same .b32.i2p address. Defaults to ./.tachyon-i2p relative to the current working directory.

pub const fn signature_type(self, sig: SigType) -> Self

Overrides the signature algorithm used the first time this destination’s keys are generated — irrelevant if a keys file already exists at the resolved path (an existing destination keeps whatever algorithm it was originally created with). See tachyon_i2p::SigType’s own docs for what’s available and why RSA isn’t one of the options; defaults to SigType::default (Eddsa25519, the I2P network’s own default).

pub fn crypto_type(self, crypto: CryptoType) -> Self

Overrides which encryption algorithm this destination’s LeaseSet2 advertises as usable — convenience for the common single-algorithm case; see encryption_types (which this is built on) for the general case, including “prefer post-quantum but still accept classical” multi-algorithm setups. See tachyon_i2p::CryptoType’s own docs for the available options.

Not calling this at all (the default) publishes libi2pd’s own automatic hybrid set — ElGamal + ECIES-X25519, plus ML-KEM-768+X25519 if this was built against a post-quantum-capable crypto backend — which is what most callers want. Call this to narrow that down to exactly one algorithm instead, e.g. for a smaller LeaseSet2 or to deliberately exclude the post-quantum component.

pub fn encryption_types(self, types: &[CryptoType]) -> Self

Overrides which encryption algorithm(s) this destination’s LeaseSet2 advertises as usable — unlike signature_type, this applies on every run, not just first-time key generation (the identity’s own certificate is always plain ElGamal regardless of this setting, per real I2P clients’ requirements — this only controls the destination’s advertised encryption capability).

Order matters: the first entry becomes the preferred type (published first in the actual LeaseSet2, and what a peer that understands multiple of the listed types will choose), with every later entry a fallback for peers that don’t recognize it — publishing something a given peer doesn’t understand at all is harmless, not an error, since it simply skips entries it can’t use and tries the next one. This is how to express “prefer post-quantum, but still reachable by peers that don’t support it yet”:

use tachyon_web::server::i2p::I2pConfig;
use tachyon_i2p::CryptoType;

let config = I2pConfig::new("my-eepsite").encryption_types(&[
    CryptoType::EciesMlkem1024X25519, // preferred: strongest post-quantum option
    CryptoType::EciesX25519,          // fallback: peers that don't understand ML-KEM yet
]);

An empty slice restores the default automatic hybrid set described on crypto_type’s docs.

pub fn tls_config(self, config: ServerConfig) -> Self

Enables TLS using a caller-supplied rustls::ServerConfig instead of the plaintext default — for example, the exact same config passed to Server::serve_https_config for a clearnet listener. Requires the tls feature.

pub fn self_signed_tls(self) -> Self

Enables TLS using a freshly generated self-signed certificate for the eepsite’s .b32.i2p address, instead of the plaintext default. Requires the cert-gen feature.

pub fn no_tls(self) -> Self

Disables TLS (the default) after a prior tls_config/ self_signed_tls call.

pub fn on_ready(self, f: impl FnOnce(&str) + Send + 'static) -> Self

Registers a callback invoked exactly once — with the published .b32.i2p address (no scheme, e.g. "abcd...xyz.b32.i2p") — as soon as the destination is created, just before requests start being served. This is the only way to observe the address programmatically, since serve_i2p_config blocks for the lifetime of the service; the address is also always logged via tracing at info level.

pub fn nickname(&self) -> &str

The nickname this service will be published under.

pub const fn tls_enabled(&self) -> bool

Whether TLS is enabled — false (the default) unless tls_config/self_signed_tls was called.

Trait Implementations

impl Debug for I2pConfig

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

Formats the value using the given formatter.