Skip to main content

Endpoint

Struct Endpoint 

Source
pub struct Endpoint {
    pub kind: String,
    pub url: String,
    pub priority: i32,
    pub health_hint_unix: Option<i64>,
    pub health: Option<EndpointHealth>,
}
Expand description

A single way to reach a sender’s data plane.

Fields§

§kind: String

Transport kind. See [Endpoint::KIND_*] constants for known values. Unknown values are preserved but MUST be skipped by recipients.

§url: String

Reachable address. Schema is transport-specific:

  • cloudflare_quick, cloudflare_named, tailscale_funnel, frp: https://host/...
  • iroh: iroh:<NodeID>@<relay_host>:<port>
§priority: i32

Sender’s preference (lower = try first). Ties broken by array order.

§health_hint_unix: Option<i64>

Optional last-known-good timestamp (Unix seconds) used by the control plane’s health cache. Absent on fresh endpoints.

§health: Option<EndpointHealth>

Background-validator health state (ADR-0014, ADR-0021). Absent on wire payloads sent by clients; populated by the control plane after the first re-probe cycle. Recipients SHOULD skip endpoints whose health.status is Unhealthy; SDKs that don’t recognise this field are forward-compatible because health is additive.

Implementations§

Source§

impl Endpoint

Source

pub const KIND_CLOUDFLARE_QUICK: &'static str = "cloudflare_quick"

Cloudflare Quick Tunnel (*.trycloudflare.com, ephemeral).

Source

pub const KIND_CLOUDFLARE_NAMED: &'static str = "cloudflare_named"

Cloudflare Named Tunnel (*.workers.dev or custom hostname, persistent).

Source

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

Iroh peer-to-peer with DERP relay fallback.

Source

pub const KIND_TAILSCALE_FUNNEL: &'static str = "tailscale_funnel"

Tailscale Funnel (public hostname on a tailnet).

Source

pub const KIND_FRP: &'static str = "frp"

FRP self-hosted reverse proxy.

Source

pub const KNOWN_KINDS: &'static [&'static str]

All kinds this crate knows how to reach. Adding a new transport in a later sprint adds a constant here + extends this array.

Source

pub fn is_known_kind(&self) -> bool

True if self.kind is in Self::KNOWN_KINDS. Recipients use this to skip forward-incompatible endpoints without failing the transfer.

Source

pub fn cloudflare_quick(url: impl Into<String>) -> Self

Convenience: Cloudflare Quick Tunnel endpoint at priority 0.

Trait Implementations§

Source§

impl Clone for Endpoint

Source§

fn clone(&self) -> Endpoint

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Endpoint

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Endpoint

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Endpoint

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Endpoint

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Endpoint

Source§

impl StructuralPartialEq for Endpoint

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,