Struct ClientId 

pub struct ClientId(String);

An OAuth client_id, known to be in canonical form.

A rule denying a client compares its id as text. If one client could spell its id two ways — https://Bad.example/…, https://bad.example:443/… — the second spelling would walk past a rule written against the first. ClientId::parse accepts exactly one spelling: the one the url crate serializes the URL back to. atproto’s reference authorization server refuses the same inputs, so a conformant client never sends another.

The atproto profile’s local form, http://localhost with an optional query, is different. Its client builds it from its own query, and many spellings build the same document: http://localhost/?a and http://localhost?a, parameters in any order, ports in its redirect URIs, which the profile does not match. So ClientId::parse rewrites every spelling of one to a single one: http://localhost/?, then each redirect_uri without its port, sorted, then one scope with its atoms sorted. A parameter the profile does not define is refused. A local id with no redirect_uri or no scope is spelled with the profile’s defaults.

Tuple Fields

0: String

Implementations

impl ClientId

pub fn parse(raw: &str) -> Result<Self, ClientIdError>

Accepts raw if it is a client_id in canonical form, and rewrites a local one into its canonical form.

Errors

Any spelling other than the canonical one, and any URL carrying credentials, a fragment, or no usable host. A local one carrying a parameter the profile does not define. See ClientIdError.

pub fn as_str(&self) -> &str

The id, as the one string every copy of it holds.

Trait Implementations

impl AsRef<str> for ClientId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ClientId

fn clone(&self) -> ClientId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientId

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

Formats the value using the given formatter.

impl Display for ClientId

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

Formats the value using the given formatter.

impl Hash for ClientId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ClientId

fn eq(&self, other: &ClientId) -> 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 ClientId

impl StructuralPartialEq for ClientId