IrohBeam.EndpointTicket (iroh_beam v0.2.0)

Standard reusable Iroh endpoint ticket.

Tickets contain an endpoint ID and current reachability hints. They are not private credentials or one-time tokens, but may disclose relay and IP addresses. Stale tickets can stop being useful as network paths change.

Summary

Types

t()

Functions

endpoint_addr(endpoint_ticket)

from_bytes(bytes)

new(addr)

parse(text)

parse!(text)

to_bytes(endpoint_ticket)

Types

t()

@type t() :: %IrohBeam.EndpointTicket{
  addr: IrohBeam.EndpointAddr.t(),
  bytes: binary(),
  text: String.t()
}

Functions

endpoint_addr(endpoint_ticket)

@spec endpoint_addr(t()) :: IrohBeam.EndpointAddr.t()

from_bytes(bytes)

@spec from_bytes(binary()) :: {:ok, t()} | {:error, IrohBeam.Error.t()}

new(addr)

@spec new(IrohBeam.EndpointAddr.t()) :: {:ok, t()} | {:error, IrohBeam.Error.t()}

parse(text)

@spec parse(String.t()) :: {:ok, t()} | {:error, IrohBeam.Error.t()}

parse!(text)

@spec parse!(String.t()) :: t()

to_bytes(endpoint_ticket)

@spec to_bytes(t()) :: binary()