//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `vta/services/get`. Version: `1.1`.
/// Why this specification version is deprecated (SPEC "Superseded and
/// Withdrawn Versions"), or `None` while it is current.
pub const DEPRECATION: Option<&str> = None;
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
/// Error types.
pub mod error {
/// Error from a `TryFrom` or `FromStr` implementation.
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
///Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct Ext(pub ::std::collections::HashMap<ExtKey, ::serde_json::Value>);
impl ::std::ops::Deref for Ext {
type Target = ::std::collections::HashMap<ExtKey, ::serde_json::Value>;
fn deref(&self) -> &::std::collections::HashMap<ExtKey, ::serde_json::Value> {
&self.0
}
}
impl ::std::convert::From<Ext> for ::std::collections::HashMap<ExtKey, ::serde_json::Value> {
fn from(value: Ext) -> Self {
value.0
}
}
impl ::std::convert::From<::std::collections::HashMap<ExtKey, ::serde_json::Value>> for Ext {
fn from(value: ::std::collections::HashMap<ExtKey, ::serde_json::Value>) -> Self {
Self(value)
}
}
///`ExtKey`
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ExtKey(::std::string::String);
impl ::std::ops::Deref for ExtKey {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ExtKey> for ::std::string::String {
fn from(value: ExtKey) -> Self {
value.0
}
}
impl ::std::str::FromStr for ExtKey {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| {
::regress::Regex::new("^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for ExtKey {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Request payload for vta/services/get. Reads one transport's current state.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Payload {
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
pub service: ServiceKind,
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///Success response to vta/services/get. Type https://trusttasks.org/spec/vta/services/get/1.1#response.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Response {
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
pub state: ServiceState,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.
///
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
#[non_exhaustive]
pub enum ServiceKind {
#[serde(rename = "didcomm")]
Didcomm,
#[serde(rename = "rest")]
Rest,
#[serde(rename = "tsp")]
Tsp,
#[serde(rename = "webauthn")]
Webauthn,
}
impl ::std::fmt::Display for ServiceKind {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::Didcomm => f.write_str("didcomm"),
Self::Rest => f.write_str("rest"),
Self::Tsp => f.write_str("tsp"),
Self::Webauthn => f.write_str("webauthn"),
}
}
}
impl ::std::str::FromStr for ServiceKind {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"didcomm" => Ok(Self::Didcomm),
"rest" => Ok(Self::Rest),
"tsp" => Ok(Self::Tsp),
"webauthn" => Ok(Self::Webauthn),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for ServiceKind {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for ServiceKind {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for ServiceKind {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
///What the agent currently advertises for one service. `enabled` is the only member every kind carries; the rest are kind-specific and absent when they do not apply. Note that `enabled: false` and an absent entry are different: the first says the agent knows about this transport and is not advertising it, the second says it has never been configured.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct ServiceState {
///RFC 3339 instant at which a scheduled drain completes. Present only while a `didcomm` mediator is draining — see `vta/services/drain/list`.
#[serde(
rename = "drainEndsAt",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub drain_ends_at: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
///Whether the agent currently advertises this transport in its DID document.
pub enabled: bool,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
pub kind: ServiceKind,
///The mediator this transport routes through. Present for `didcomm` and `tsp`.
#[serde(
rename = "mediatorDid",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub mediator_did: ::std::option::Option<::std::string::String>,
///The advertised endpoint. Present for `rest` and `webauthn`.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub url: ::std::option::Option<::std::string::String>,
}
impl ServiceState {
pub fn builder() -> builder::ServiceState {
Default::default()
}
}
/// Types for composing complex structures.
pub mod builder {
#[derive(Clone, Debug)]
pub struct Payload {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
service: ::std::result::Result<super::ServiceKind, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
service: Err("no value supplied for service".to_string()),
}
}
}
impl Payload {
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn service<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ServiceKind>,
T::Error: ::std::fmt::Display,
{
self.service = value
.try_into()
.map_err(|e| format!("error converting supplied value for service: {e}"));
self
}
}
impl ::std::convert::TryFrom<Payload> for super::Payload {
type Error = super::error::ConversionError;
fn try_from(value: Payload) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
ext: value.ext?,
service: value.service?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
ext: Ok(value.ext),
service: Ok(value.service),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
state: ::std::result::Result<super::ServiceState, ::std::string::String>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
state: Err("no value supplied for state".to_string()),
}
}
}
impl Response {
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn state<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ServiceState>,
T::Error: ::std::fmt::Display,
{
self.state = value
.try_into()
.map_err(|e| format!("error converting supplied value for state: {e}"));
self
}
}
impl ::std::convert::TryFrom<Response> for super::Response {
type Error = super::error::ConversionError;
fn try_from(value: Response) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
ext: value.ext?,
state: value.state?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
ext: Ok(value.ext),
state: Ok(value.state),
}
}
}
#[derive(Clone, Debug)]
pub struct ServiceState {
drain_ends_at: ::std::result::Result<
::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
::std::string::String,
>,
enabled: ::std::result::Result<bool, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
kind: ::std::result::Result<super::ServiceKind, ::std::string::String>,
mediator_did: ::std::result::Result<
::std::option::Option<::std::string::String>,
::std::string::String,
>,
url: ::std::result::Result<
::std::option::Option<::std::string::String>,
::std::string::String,
>,
}
impl ::std::default::Default for ServiceState {
fn default() -> Self {
Self {
drain_ends_at: Ok(Default::default()),
enabled: Err("no value supplied for enabled".to_string()),
ext: Ok(Default::default()),
kind: Err("no value supplied for kind".to_string()),
mediator_did: Ok(Default::default()),
url: Ok(Default::default()),
}
}
}
impl ServiceState {
pub fn drain_ends_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<
::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
>,
T::Error: ::std::fmt::Display,
{
self.drain_ends_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for drain_ends_at: {e}"));
self
}
pub fn enabled<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<bool>,
T::Error: ::std::fmt::Display,
{
self.enabled = value
.try_into()
.map_err(|e| format!("error converting supplied value for enabled: {e}"));
self
}
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn kind<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ServiceKind>,
T::Error: ::std::fmt::Display,
{
self.kind = value
.try_into()
.map_err(|e| format!("error converting supplied value for kind: {e}"));
self
}
pub fn mediator_did<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<::std::string::String>>,
T::Error: ::std::fmt::Display,
{
self.mediator_did = value
.try_into()
.map_err(|e| format!("error converting supplied value for mediator_did: {e}"));
self
}
pub fn url<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<::std::string::String>>,
T::Error: ::std::fmt::Display,
{
self.url = value
.try_into()
.map_err(|e| format!("error converting supplied value for url: {e}"));
self
}
}
impl ::std::convert::TryFrom<ServiceState> for super::ServiceState {
type Error = super::error::ConversionError;
fn try_from(
value: ServiceState,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
drain_ends_at: value.drain_ends_at?,
enabled: value.enabled?,
ext: value.ext?,
kind: value.kind?,
mediator_did: value.mediator_did?,
url: value.url?,
})
}
}
impl ::std::convert::From<super::ServiceState> for ServiceState {
fn from(value: super::ServiceState) -> Self {
Self {
drain_ends_at: Ok(value.drain_ends_at),
enabled: Ok(value.enabled),
ext: Ok(value.ext),
kind: Ok(value.kind),
mediator_did: Ok(value.mediator_did),
url: Ok(value.url),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vta/services/get/1.1";
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\"$defs\":{\"Ext\":{\"additionalProperties\":true,\"description\":\"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\"minProperties\":1,\"propertyNames\":{\"pattern\":\"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"},\"title\":\"Ext\",\"type\":\"object\"},\"Response\":{\"$anchor\":\"response\",\"additionalProperties\":false,\"description\":\"Success response to vta/services/get. Type https://trusttasks.org/spec/vta/services/get/1.1#response.\",\"properties\":{\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"state\":{\"$ref\":\"#/$defs/ServiceState\"}},\"required\":[\"state\"],\"title\":\"VTA Services — Get — response payload\",\"type\":\"object\"},\"ServiceKind\":{\"description\":\"Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.\",\"enum\":[\"didcomm\",\"rest\",\"tsp\",\"webauthn\"],\"title\":\"ServiceKind\",\"type\":\"string\"},\"ServiceState\":{\"additionalProperties\":false,\"description\":\"What the agent currently advertises for one service. `enabled` is the only member every kind carries; the rest are kind-specific and absent when they do not apply. Note that `enabled: false` and an absent entry are different: the first says the agent knows about this transport and is not advertising it, the second says it has never been configured.\",\"properties\":{\"drainEndsAt\":{\"description\":\"RFC 3339 instant at which a scheduled drain completes. Present only while a `didcomm` mediator is draining — see `vta/services/drain/list`.\",\"format\":\"date-time\",\"type\":\"string\"},\"enabled\":{\"description\":\"Whether the agent currently advertises this transport in its DID document.\",\"type\":\"boolean\"},\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"kind\":{\"$ref\":\"#/$defs/ServiceKind\"},\"mediatorDid\":{\"description\":\"The mediator this transport routes through. Present for `didcomm` and `tsp`.\",\"type\":\"string\"},\"url\":{\"description\":\"The advertised endpoint. Present for `rest` and `webauthn`.\",\"type\":\"string\"}},\"required\":[\"kind\",\"enabled\"],\"title\":\"ServiceState\",\"type\":\"object\"}},\"$id\":\"https://trusttasks.org/spec/vta/services/get/1.1\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"additionalProperties\":false,\"description\":\"Request payload for vta/services/get. Reads one transport's current state.\",\"properties\":{\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"service\":{\"$ref\":\"#/$defs/ServiceKind\"}},\"required\":[\"service\"],\"title\":\"VTA Services — Get — payload\",\"type\":\"object\"}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vta/services/get/1.1#response";
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\"$defs\":{\"Ext\":{\"additionalProperties\":true,\"description\":\"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\"minProperties\":1,\"propertyNames\":{\"pattern\":\"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"},\"title\":\"Ext\",\"type\":\"object\"},\"Response\":{\"$anchor\":\"response\",\"additionalProperties\":false,\"description\":\"Success response to vta/services/get. Type https://trusttasks.org/spec/vta/services/get/1.1#response.\",\"properties\":{\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"state\":{\"$ref\":\"#/$defs/ServiceState\"}},\"required\":[\"state\"],\"title\":\"VTA Services — Get — response payload\",\"type\":\"object\"},\"ServiceKind\":{\"description\":\"Which transport a task is acting on. This is the discriminator: it selects which member of `config` is meaningful, and a payload naming one kind with another's config is malformed rather than merely ignored.\",\"enum\":[\"didcomm\",\"rest\",\"tsp\",\"webauthn\"],\"title\":\"ServiceKind\",\"type\":\"string\"},\"ServiceState\":{\"additionalProperties\":false,\"description\":\"What the agent currently advertises for one service. `enabled` is the only member every kind carries; the rest are kind-specific and absent when they do not apply. Note that `enabled: false` and an absent entry are different: the first says the agent knows about this transport and is not advertising it, the second says it has never been configured.\",\"properties\":{\"drainEndsAt\":{\"description\":\"RFC 3339 instant at which a scheduled drain completes. Present only while a `didcomm` mediator is draining — see `vta/services/drain/list`.\",\"format\":\"date-time\",\"type\":\"string\"},\"enabled\":{\"description\":\"Whether the agent currently advertises this transport in its DID document.\",\"type\":\"boolean\"},\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"kind\":{\"$ref\":\"#/$defs/ServiceKind\"},\"mediatorDid\":{\"description\":\"The mediator this transport routes through. Present for `didcomm` and `tsp`.\",\"type\":\"string\"},\"url\":{\"description\":\"The advertised endpoint. Present for `rest` and `webauthn`.\",\"type\":\"string\"}},\"required\":[\"kind\",\"enabled\"],\"title\":\"ServiceState\",\"type\":\"object\"}},\"$ref\":\"#/$defs/Response\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\"}\n",
);
}
impl crate::RequestPayload for Payload {
type Response = Response;
}
/// The earlier `MAJOR.MINOR` of this slug that this version declares it
/// extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
/// `None`. Only the direct declaration; walk a chain with
/// [`crate::extension::extends_for`].
pub const EXTENDS: Option<&str> = None;
/// The extended error codes this specification declares (SPEC §7.3 item 9,
/// §8.5), in declaration order. Empty when it declares none.
pub const ERROR_CODES: &[crate::DeclaredErrorCode] = &[error_codes::NOT_FOUND];
/// One constant per extended error code this specification declares
/// (SPEC §7.3 item 9), named for its local part.
///
/// Emit these rather than a string literal: the code is read from the
/// specification, so it cannot name a code the specification never
/// declared.
pub mod error_codes {
/// `vta/services/get:notFound`
///
/// The agent has never held this transport. Distinct from holding it disabled, which returns a state with enabled:false.
///
/// Declared `retryable: false`.
pub const NOT_FOUND: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vta/services/get:notFound",
retryable: false,
details_schema: ::core::option::Option::None,
};
}