Struct ServiceEndpoint 

pub struct ServiceEndpoint {
    pub id: String,
    pub service_type: String,
    pub service_endpoint: String,
    pub label: Option<String>,
    pub description: Option<String>,
    pub properties: Option<BTreeMap<String, String>>,
}

A service endpoint in an OAS Identity Document.

See OAS Specification §5.6 for standard service types.

Examples

use oas_document::service::ServiceEndpoint;

let svc = ServiceEndpoint {
    id: "did:oas:ns:agent:bot#api".to_string(),
    service_type: "OASEntity".to_string(),
    service_endpoint: "https://example.com/bot".to_string(),
    label: Some("Primary API".to_string()),
    description: Some("Main agent interaction endpoint".to_string()),
    properties: None,
};

Fields

id: String

The service ID (e.g., did:oas:ns:agent:bot#service-1).

service_type: String

The service type.

service_endpoint: String

The service endpoint URI.

label: Option<String>

Human-readable label for this service.

description: Option<String>

Human-readable description of what this service does.

properties: Option<BTreeMap<String, String>>

Arbitrary key-value properties for this service. Useful for protocol-specific metadata (e.g., API version, auth scheme).

Trait Implementations

impl Clone for ServiceEndpoint

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceEndpoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServiceEndpoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ServiceEndpoint

impl PartialEq for ServiceEndpoint

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ServiceEndpoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ServiceEndpoint