Development Documentation (main branch) - For stable release docs, see docs.rs/eidetica

IrohTransport

Struct IrohTransport 

Source
pub struct IrohTransport { /* private fields */ }
Expand description

Iroh transport implementation using QUIC peer-to-peer networking.

Provides NAT traversal and direct peer-to-peer connectivity using the Iroh protocol. Supports both relay-assisted and direct connections.

§How It Works

  1. Discovery: Peers find each other via relay servers or direct addresses
  2. Connection: Attempts direct connection through NAT hole-punching
  3. Fallback: Uses relay servers if direct connection fails
  4. Upgrade: Automatically upgrades to direct connection when possible

§Server Addresses

Addresses use iroh’s standard EndpointTicket format (postcard + base32-lower with endpoint prefix) for both get_server_address() and DatabaseTicket URLs.

§Example

use eidetica::sync::transports::iroh::IrohTransport;
use iroh::RelayMode;

// Create with defaults (production relay servers)
let transport = IrohTransport::new()?;

// Or use the builder for custom configuration
let transport = IrohTransport::builder()
    .relay_mode(RelayMode::Staging)
    .build()?;

Implementations§

Source§

impl IrohTransport

Source

pub const TRANSPORT_TYPE: &'static str = "iroh"

Transport type identifier for Iroh

Source

pub fn new() -> Result<Self>

Create a new Iroh transport instance with production defaults.

Uses RelayMode::Default which connects to n0’s production relay infrastructure. For custom configuration, use IrohTransport::builder().

The endpoint will be lazily initialized on first use.

§Example
use eidetica::sync::transports::iroh::IrohTransport;

let transport = IrohTransport::new()?;
// Use with: sync.enable_iroh_transport_with_config(transport)?;
Source

pub fn builder() -> IrohTransportBuilder

Create a builder for configuring the transport.

Allows customization of relay modes and other transport options.

§Example
use eidetica::sync::transports::iroh::IrohTransport;
use iroh::RelayMode;

let transport = IrohTransport::builder()
    .relay_mode(RelayMode::Disabled)
    .build()?;

Trait Implementations§

Source§

impl SyncTransport for IrohTransport

Source§

fn transport_type(&self) -> &'static str

Get the transport type identifier. Read more
Source§

fn can_handle_address(&self, address: &Address) -> bool

Check if this transport can handle the given address Read more
Source§

fn start_server<'life0, 'async_trait>( &'life0 mut self, handler: Arc<dyn SyncHandler>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Start a server with the pre-configured bind address. Read more
Source§

fn stop_server<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Stop the running server gracefully. Read more
Source§

fn send_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, address: &'life1 Address, request: &'life2 SyncRequest, ) -> Pin<Box<dyn Future<Output = Result<SyncResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Send a sync request to a peer and receive a response. Read more
Source§

fn is_server_running(&self) -> bool

Check if the server is currently running. Read more
Source§

fn get_server_address(&self) -> Result<String>

Get the address the server is currently bound to. Read more
Source§

fn send_entries<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, address: &'life1 Address, entries: &'life2 [Entry], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Send entries to a sync peer and ensure they are acknowledged. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more