Struct Zone 

pub struct Zone {
    pds_host: String,
    host: String,
}

The DNS zone agents are minted under, plus the port their PDS listens on during development.

A zone exists because atproto supports “only hostname-level did:web DIDs: path-based DIDs are not supported”. Every agent therefore needs its own hostname, not its own path under a shared one, so the deployment has to own a name it can put arbitrary subdomains under.

A zone is constructed against the hostname of the PDS that will serve the accounts, but it does not have to sit at or below that hostname: a PDS at pds.example.com may delegate pds.example.com, agents.pds.example.com, or agents.anotherexample.com, provided it holds DNS credentials for whichever zone it names. Which server serves a given agent is answered by resolving the agent’s DID document, which carries the PDS’s serviceEndpoint under #atproto_pds — not by inspecting the DID string.

Fields

pds_host: String

host: String

Implementations

impl Zone

pub fn new(pds_host: &str) -> Result<Self, DidError>

A zone that is the PDS’s own hostname: agents become its immediate subdomains.

pub fn delegated(pds_host: &str, zone_host: &str) -> Result<Self, DidError>

A zone the PDS delegates agent names from. It may be any hostname the PDS holds DNS credentials for, including one that does not sit under pds_host at all.

pub fn host(&self) -> &str

The base hostname agents are minted under.

pub fn is_loopback(&self) -> bool

Whether this zone is localhost or under it, and so development-only.

RFC 6761 reserves that subtree for loopback, so every agent hostname minted here resolves without a zone to write, has no operator’s repository to read and is reachable by no relay. The server picks its listener, its certificate source and what it polls for by this.

pub fn pds_host(&self) -> &str

The hostname of the PDS this zone is delegated from.

pub fn service_did(&self) -> String

The did:web naming the server itself, rather than any account on it.

This is the DID a human’s vouch record points at when it says “this is my personal data server and I take responsibility for the agents on it”. It is the zone hostname and not the PDS hostname: a ZoneRegistry holds one Zone per zone a deployment mints under, and the vouch has to name the zone whose accounts it is vouching for — naming the PDS hostname instead would not say which of a deployment’s several zones is covered.

Returned as a string. It is a did:web for a service, not for an account, and handing back an AccountDid would say otherwise.

Trait Implementations

impl Clone for Zone

fn clone(&self) -> Zone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Zone

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

Formats the value using the given formatter.

impl PartialEq for Zone

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Zone

impl StructuralPartialEq for Zone