Skip to main content

WebvhPathMode

Enum WebvhPathMode 

Source
pub enum WebvhPathMode {
    WellKnown,
    Explicit(String),
    AutoAssign,
}
Expand description

How the <path> segment of a server-managed did:webvh is chosen.

Only meaningful when a hosting server is selected (server_id is set). A serverless DID always resolves at <host>/.well-known/did.jsonl and ignores this — serverless mode is selected by the absence of server_id, not by this enum. The three variants map onto the hosting server’s check-name / create_did path contract:

AutoAssign is the default because that is the long-standing “no path given → the server assigns one” contract: the setup wizard’s “leave blank → server-assigned” prompt maps a blank path here. An absent path has never meant the .well-known root on a hosting server — that is the serverless case (selected by the absence of a server_id, where the DID location comes from the URL itself).

Variants§

§

WellKnown

Root DID at the host: resolves at <host>/.well-known/did.jsonl.

§

Explicit(String)

Operator-chosen path label: <host>/<path>/did.jsonl.

§

AutoAssign

Let the hosting server allocate the path.

Implementations§

Source§

impl WebvhPathMode

Source

pub fn to_request_path(&self) -> Option<&str>

The path string to hand the hosting server’s check-name / create_did call. Some(".well-known") / Some(label) reserve a specific slot; None tells the host to allocate one (the auto-assign contract — the host mints a mnemonic).

Returning None for AutoAssign is load-bearing: the DIDComm/REST clients must omit the path wire field for auto-assign. Sending an empty string instead makes the host reject it with e.p.did.path-invalid (“path must not be empty”), since the host validates a present-but-empty path.

Source

pub fn resolve( path_mode: Option<WebvhPathMode>, legacy_path: Option<String>, ) -> Self

Resolve the effective mode from the new explicit path_mode field and the legacy path: Option<String> field. path_mode wins when present; otherwise the legacy path is interpreted (via From<Option<String>>) so pre-enum callers keep working.

Trait Implementations§

Source§

impl Clone for WebvhPathMode

Source§

fn clone(&self) -> WebvhPathMode

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 WebvhPathMode

Source§

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

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

impl Default for WebvhPathMode

Source§

fn default() -> WebvhPathMode

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for WebvhPathMode

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 Eq for WebvhPathMode

Source§

impl From<Option<String>> for WebvhPathMode

Source§

fn from(path: Option<String>) -> Self

Converts to this type from the input type.
Source§

impl From<String> for WebvhPathMode

Source§

fn from(path: String) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for WebvhPathMode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for WebvhPathMode

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 StructuralPartialEq for WebvhPathMode

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Same for T

Source§

type Output = T

Should always be Self
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.