Struct ApiSecret 

pub struct ApiSecret {
    pub secret: SecretKey,
    pub remote: EndpointAddr,
}

The secret material used to connect your services.iroh.computer project. The value of these should be treated like any other API key: guard them carefully.

Fields

secret: SecretKey

ED25519 secret used to construct rcans from

remote: EndpointAddr

The iroh-services endpoint to direct requests to

Implementations

impl ApiSecret

pub fn new(secret: SecretKey, remote: impl Into<EndpointAddr>) -> Self

Creates a new ticket.

pub fn from_env_var(env_var: &str) -> Result<Self>

Read an Api Secret from a given environment variable

pub fn addr(&self) -> &EndpointAddr

The [EndpointAddr] of the provider for this ticket.

Trait Implementations

impl Clone for ApiSecret

fn clone(&self) -> ApiSecret

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiSecret

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

Formats the value using the given formatter.

impl Display for ApiSecret

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

Formats the value using the given formatter.

impl FromStr for ApiSecret

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ticket for ApiSecret

const KIND: &'static str = "services"

String prefix describing the kind of iroh ticket.

fn encode_bytes(&self) -> Vec<u8>

Encode the ticket into its byte representation.

fn decode_bytes(bytes: &[u8]) -> Result<Self, ParseError>

Decode a ticket from its byte representation.

fn encode_string(&self) -> String

Encode the ticket into its canonical string form.

fn decode_string(s: &str) -> Result<Self, ParseError>

Decode a ticket from its canonical string form.