//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `device/set-wake`. Version: `0.1`.
#![allow(deprecated)]
/// Why this specification version is deprecated (SPEC "Superseded and
/// Withdrawn Versions"), or `None` while it is current.
pub const DEPRECATION: Option<&str> = Some("superseded by device/set-wake/0.2");
#[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())
})
}
}
///A device conveys to its VTA the opaque WakeHandle it obtained from a push gateway, so the VTA can own the trigger allowlist and provision the gateway. Carries no platform push token — only the handle. Present `wakeHandle` sets/replaces the wake channel; absent clears it (device becomes non-wakeable). Idempotent; re-issued on token rotation. See the push wake-up binding (https://trusttasks.org/binding/push/0.1).
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
#[deprecated(note = "superseded by device/set-wake/0.2")]
pub struct Payload {
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///OPTIONAL, advisory. The abstract platform behind the handle, for device/list visibility only. The VTA never sees the token; this is a non-authoritative hint.
#[serde(
rename = "pushPlatform",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub push_platform: ::std::option::Option<PayloadPushPlatform>,
///OPTIONAL, advisory. DIDs the device suggests as wake triggers (e.g. its mediator). The VTA owns the allowlist and MAY ignore this entirely — it is a hint, not an instruction.
#[serde(
rename = "suggestedTriggers",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub suggested_triggers: ::std::option::Option<Vec<PayloadSuggestedTriggersItem>>,
///OPTIONAL. The opaque gateway-issued handle for this device's push channel. Omit to clear the wake channel (the VTA empties the gateway allowlist; the device becomes non-wakeable).
#[serde(
rename = "wakeHandle",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub wake_handle: ::std::option::Option<WakeHandle>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Default::default(),
push_platform: Default::default(),
suggested_triggers: Default::default(),
wake_handle: Default::default(),
}
}
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///OPTIONAL, advisory. The abstract platform behind the handle, for device/list visibility only. The VTA never sees the token; this is a non-authoritative hint.
///
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
#[non_exhaustive]
pub enum PayloadPushPlatform {
#[serde(rename = "apns")]
Apns,
#[serde(rename = "fcm")]
Fcm,
#[serde(rename = "webpush")]
Webpush,
}
impl ::std::fmt::Display for PayloadPushPlatform {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::Apns => f.write_str("apns"),
Self::Fcm => f.write_str("fcm"),
Self::Webpush => f.write_str("webpush"),
}
}
}
impl ::std::str::FromStr for PayloadPushPlatform {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"apns" => Ok(Self::Apns),
"fcm" => Ok(Self::Fcm),
"webpush" => Ok(Self::Webpush),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for PayloadPushPlatform {
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 PayloadPushPlatform {
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 PayloadPushPlatform {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
///`PayloadSuggestedTriggersItem`
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadSuggestedTriggersItem(::std::string::String);
impl ::std::ops::Deref for PayloadSuggestedTriggersItem {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadSuggestedTriggersItem> for ::std::string::String {
fn from(value: PayloadSuggestedTriggersItem) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadSuggestedTriggersItem {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadSuggestedTriggersItem {
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 PayloadSuggestedTriggersItem {
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 PayloadSuggestedTriggersItem {
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 PayloadSuggestedTriggersItem {
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())
})
}
}
///`Response`
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
#[deprecated(note = "superseded by device/set-wake/0.2")]
pub struct Response {
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Whether the device now has a usable wake channel (true after a successful set, false after a clear).
#[serde(rename = "pushCapable")]
pub push_capable: bool,
///The effective allowlist the VTA computed and provisioned to the gateway. Absent when the wake channel was cleared.
#[serde(
rename = "triggerPolicy",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub trigger_policy: ::std::option::Option<WakeTriggerPolicy>,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///An opaque, gateway-issued reference to a device's push channel (push wake-up binding, https://trusttasks.org/binding/push/0.1). The push gateway returns it to the device at registration; the device conveys it to its VTA (device/set-wake), and the VTA provisions it to authorized triggers (its mediator and/or itself). The raw platform push token (APNs/FCM/WebPush) is held ONLY by the gateway and is never represented here — the handle abstracts the platform, so adding new push methods (e.g. PWA Web Push) needs no change to triggers or VTA config. A handle is a bearer capability to *request* a wake (subject to the gateway's allowlist), never to read the channel.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct WakeHandle {
///The push gateway that issued this handle and acts on it — a DID (DIDComm-reachable gateway) or an https URL (REST gateway). A trigger sends its contentless wake request here.
pub gateway: WakeHandleGateway,
///Opaque gateway-issued identifier for the device's push channel. Reveals no platform token. Rotates whenever the device re-registers a new platform token with the gateway; the device then re-conveys the fresh handle via device/set-wake.
pub handle: WakeHandleHandle,
}
impl WakeHandle {
pub fn builder() -> builder::WakeHandle {
Default::default()
}
}
///The push gateway that issued this handle and acts on it — a DID (DIDComm-reachable gateway) or an https URL (REST gateway). A trigger sends its contentless wake request here.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct WakeHandleGateway(::std::string::String);
impl ::std::ops::Deref for WakeHandleGateway {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<WakeHandleGateway> for ::std::string::String {
fn from(value: WakeHandleGateway) -> Self {
value.0
}
}
impl ::std::str::FromStr for WakeHandleGateway {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for WakeHandleGateway {
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 WakeHandleGateway {
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 WakeHandleGateway {
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 WakeHandleGateway {
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())
})
}
}
///Opaque gateway-issued identifier for the device's push channel. Reveals no platform token. Rotates whenever the device re-registers a new platform token with the gateway; the device then re-conveys the fresh handle via device/set-wake.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct WakeHandleHandle(::std::string::String);
impl ::std::ops::Deref for WakeHandleHandle {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<WakeHandleHandle> for ::std::string::String {
fn from(value: WakeHandleHandle) -> Self {
value.0
}
}
impl ::std::str::FromStr for WakeHandleHandle {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for WakeHandleHandle {
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 WakeHandleHandle {
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 WakeHandleHandle {
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 WakeHandleHandle {
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())
})
}
}
///VTA-owned allowlist of the DIDs permitted to trigger a wake for a given WakeHandle (push wake-up binding, https://trusttasks.org/binding/push/0.1). The VTA is the source of truth for this policy — all device config state resides at the VTA — and provisions it to the gateway, which ENFORCES it: a wake request from a DID not on the list is refused. Typically holds the device's mediator DID (queue-driven wake, where the mediator alone knows the device is offline) and/or the VTA's own DID (policy-driven wake, e.g. a step-up the VTA is delegating to this device).
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct WakeTriggerPolicy {
///DIDs authorized to trigger a wake for this handle. An empty array means no party may wake the device (push effectively disabled while the handle exists). The gateway authenticates the trigger's DID before checking membership.
#[serde(rename = "allowedTriggers")]
pub allowed_triggers: Vec<WakeTriggerPolicyAllowedTriggersItem>,
}
impl WakeTriggerPolicy {
pub fn builder() -> builder::WakeTriggerPolicy {
Default::default()
}
}
///`WakeTriggerPolicyAllowedTriggersItem`
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct WakeTriggerPolicyAllowedTriggersItem(::std::string::String);
impl ::std::ops::Deref for WakeTriggerPolicyAllowedTriggersItem {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<WakeTriggerPolicyAllowedTriggersItem> for ::std::string::String {
fn from(value: WakeTriggerPolicyAllowedTriggersItem) -> Self {
value.0
}
}
impl ::std::str::FromStr for WakeTriggerPolicyAllowedTriggersItem {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for WakeTriggerPolicyAllowedTriggersItem {
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 WakeTriggerPolicyAllowedTriggersItem {
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 WakeTriggerPolicyAllowedTriggersItem {
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 WakeTriggerPolicyAllowedTriggersItem {
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())
})
}
}
/// 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>,
push_platform: ::std::result::Result<
::std::option::Option<super::PayloadPushPlatform>,
::std::string::String,
>,
suggested_triggers: ::std::result::Result<
::std::option::Option<Vec<super::PayloadSuggestedTriggersItem>>,
::std::string::String,
>,
wake_handle:
::std::result::Result<::std::option::Option<super::WakeHandle>, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
push_platform: Ok(Default::default()),
suggested_triggers: Ok(Default::default()),
wake_handle: Ok(Default::default()),
}
}
}
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 push_platform<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::PayloadPushPlatform>>,
T::Error: ::std::fmt::Display,
{
self.push_platform = value
.try_into()
.map_err(|e| format!("error converting supplied value for push_platform: {e}"));
self
}
pub fn suggested_triggers<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<
::std::option::Option<Vec<super::PayloadSuggestedTriggersItem>>,
>,
T::Error: ::std::fmt::Display,
{
self.suggested_triggers = value.try_into().map_err(|e| {
format!("error converting supplied value for suggested_triggers: {e}")
});
self
}
pub fn wake_handle<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::WakeHandle>>,
T::Error: ::std::fmt::Display,
{
self.wake_handle = value
.try_into()
.map_err(|e| format!("error converting supplied value for wake_handle: {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?,
push_platform: value.push_platform?,
suggested_triggers: value.suggested_triggers?,
wake_handle: value.wake_handle?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
ext: Ok(value.ext),
push_platform: Ok(value.push_platform),
suggested_triggers: Ok(value.suggested_triggers),
wake_handle: Ok(value.wake_handle),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
push_capable: ::std::result::Result<bool, ::std::string::String>,
trigger_policy: ::std::result::Result<
::std::option::Option<super::WakeTriggerPolicy>,
::std::string::String,
>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
push_capable: Err("no value supplied for push_capable".to_string()),
trigger_policy: Ok(Default::default()),
}
}
}
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 push_capable<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<bool>,
T::Error: ::std::fmt::Display,
{
self.push_capable = value
.try_into()
.map_err(|e| format!("error converting supplied value for push_capable: {e}"));
self
}
pub fn trigger_policy<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::WakeTriggerPolicy>>,
T::Error: ::std::fmt::Display,
{
self.trigger_policy = value
.try_into()
.map_err(|e| format!("error converting supplied value for trigger_policy: {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?,
push_capable: value.push_capable?,
trigger_policy: value.trigger_policy?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
ext: Ok(value.ext),
push_capable: Ok(value.push_capable),
trigger_policy: Ok(value.trigger_policy),
}
}
}
#[derive(Clone, Debug)]
pub struct WakeHandle {
gateway: ::std::result::Result<super::WakeHandleGateway, ::std::string::String>,
handle: ::std::result::Result<super::WakeHandleHandle, ::std::string::String>,
}
impl ::std::default::Default for WakeHandle {
fn default() -> Self {
Self {
gateway: Err("no value supplied for gateway".to_string()),
handle: Err("no value supplied for handle".to_string()),
}
}
}
impl WakeHandle {
pub fn gateway<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::WakeHandleGateway>,
T::Error: ::std::fmt::Display,
{
self.gateway = value
.try_into()
.map_err(|e| format!("error converting supplied value for gateway: {e}"));
self
}
pub fn handle<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::WakeHandleHandle>,
T::Error: ::std::fmt::Display,
{
self.handle = value
.try_into()
.map_err(|e| format!("error converting supplied value for handle: {e}"));
self
}
}
impl ::std::convert::TryFrom<WakeHandle> for super::WakeHandle {
type Error = super::error::ConversionError;
fn try_from(
value: WakeHandle,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
gateway: value.gateway?,
handle: value.handle?,
})
}
}
impl ::std::convert::From<super::WakeHandle> for WakeHandle {
fn from(value: super::WakeHandle) -> Self {
Self {
gateway: Ok(value.gateway),
handle: Ok(value.handle),
}
}
}
#[derive(Clone, Debug)]
pub struct WakeTriggerPolicy {
allowed_triggers: ::std::result::Result<
Vec<super::WakeTriggerPolicyAllowedTriggersItem>,
::std::string::String,
>,
}
impl ::std::default::Default for WakeTriggerPolicy {
fn default() -> Self {
Self {
allowed_triggers: Err("no value supplied for allowed_triggers".to_string()),
}
}
}
impl WakeTriggerPolicy {
pub fn allowed_triggers<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<Vec<super::WakeTriggerPolicyAllowedTriggersItem>>,
T::Error: ::std::fmt::Display,
{
self.allowed_triggers = value
.try_into()
.map_err(|e| format!("error converting supplied value for allowed_triggers: {e}"));
self
}
}
impl ::std::convert::TryFrom<WakeTriggerPolicy> for super::WakeTriggerPolicy {
type Error = super::error::ConversionError;
fn try_from(
value: WakeTriggerPolicy,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
allowed_triggers: value.allowed_triggers?,
})
}
}
impl ::std::convert::From<super::WakeTriggerPolicy> for WakeTriggerPolicy {
fn from(value: super::WakeTriggerPolicy) -> Self {
Self {
allowed_triggers: Ok(value.allowed_triggers),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/device/set-wake/0.1";
const IS_PROOF_REQUIRED: bool = true;
const IS_ISSUED_AT_REQUIRED: bool = true;
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,\"properties\":{\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"pushCapable\":{\"description\":\"Whether the device now has a usable wake channel (true after a successful set, false after a clear).\",\"type\":\"boolean\"},\"triggerPolicy\":{\"$ref\":\"#/$defs/WakeTriggerPolicy\",\"description\":\"The effective allowlist the VTA computed and provisioned to the gateway. Absent when the wake channel was cleared.\"}},\"required\":[\"pushCapable\"],\"title\":\"Device Set Wake — response payload\",\"type\":\"object\"},\"WakeHandle\":{\"additionalProperties\":false,\"description\":\"An opaque, gateway-issued reference to a device's push channel (push wake-up binding, https://trusttasks.org/binding/push/0.1). The push gateway returns it to the device at registration; the device conveys it to its VTA (device/set-wake), and the VTA provisions it to authorized triggers (its mediator and/or itself). The raw platform push token (APNs/FCM/WebPush) is held ONLY by the gateway and is never represented here — the handle abstracts the platform, so adding new push methods (e.g. PWA Web Push) needs no change to triggers or VTA config. A handle is a bearer capability to *request* a wake (subject to the gateway's allowlist), never to read the channel.\",\"properties\":{\"gateway\":{\"description\":\"The push gateway that issued this handle and acts on it — a DID (DIDComm-reachable gateway) or an https URL (REST gateway). A trigger sends its contentless wake request here.\",\"minLength\":1,\"type\":\"string\"},\"handle\":{\"description\":\"Opaque gateway-issued identifier for the device's push channel. Reveals no platform token. Rotates whenever the device re-registers a new platform token with the gateway; the device then re-conveys the fresh handle via device/set-wake.\",\"minLength\":1,\"type\":\"string\"}},\"required\":[\"gateway\",\"handle\"],\"title\":\"WakeHandle\",\"type\":\"object\"},\"WakeTriggerPolicy\":{\"additionalProperties\":false,\"description\":\"VTA-owned allowlist of the DIDs permitted to trigger a wake for a given WakeHandle (push wake-up binding, https://trusttasks.org/binding/push/0.1). The VTA is the source of truth for this policy — all device config state resides at the VTA — and provisions it to the gateway, which ENFORCES it: a wake request from a DID not on the list is refused. Typically holds the device's mediator DID (queue-driven wake, where the mediator alone knows the device is offline) and/or the VTA's own DID (policy-driven wake, e.g. a step-up the VTA is delegating to this device).\",\"properties\":{\"allowedTriggers\":{\"description\":\"DIDs authorized to trigger a wake for this handle. An empty array means no party may wake the device (push effectively disabled while the handle exists). The gateway authenticates the trigger's DID before checking membership.\",\"items\":{\"minLength\":1,\"type\":\"string\"},\"type\":\"array\",\"uniqueItems\":true}},\"required\":[\"allowedTriggers\"],\"title\":\"WakeTriggerPolicy\",\"type\":\"object\"}},\"$id\":\"https://trusttasks.org/spec/device/set-wake/0.1\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"additionalProperties\":false,\"description\":\"A device conveys to its VTA the opaque WakeHandle it obtained from a push gateway, so the VTA can own the trigger allowlist and provision the gateway. Carries no platform push token — only the handle. Present `wakeHandle` sets/replaces the wake channel; absent clears it (device becomes non-wakeable). Idempotent; re-issued on token rotation. See the push wake-up binding (https://trusttasks.org/binding/push/0.1).\",\"properties\":{\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"pushPlatform\":{\"description\":\"OPTIONAL, advisory. The abstract platform behind the handle, for device/list visibility only. The VTA never sees the token; this is a non-authoritative hint.\",\"enum\":[\"apns\",\"fcm\",\"webpush\"],\"type\":\"string\"},\"suggestedTriggers\":{\"description\":\"OPTIONAL, advisory. DIDs the device suggests as wake triggers (e.g. its mediator). The VTA owns the allowlist and MAY ignore this entirely — it is a hint, not an instruction.\",\"items\":{\"minLength\":1,\"type\":\"string\"},\"type\":\"array\",\"uniqueItems\":true},\"wakeHandle\":{\"$ref\":\"#/$defs/WakeHandle\",\"description\":\"OPTIONAL. The opaque gateway-issued handle for this device's push channel. Omit to clear the wake channel (the VTA empties the gateway allowlist; the device becomes non-wakeable).\"}},\"title\":\"Device Set Wake — payload\",\"type\":\"object\"}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/device/set-wake/0.1#response";
const IS_PROOF_REQUIRED: bool = true;
const IS_ISSUED_AT_REQUIRED: bool = true;
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,\"properties\":{\"ext\":{\"$ref\":\"#/$defs/Ext\"},\"pushCapable\":{\"description\":\"Whether the device now has a usable wake channel (true after a successful set, false after a clear).\",\"type\":\"boolean\"},\"triggerPolicy\":{\"$ref\":\"#/$defs/WakeTriggerPolicy\",\"description\":\"The effective allowlist the VTA computed and provisioned to the gateway. Absent when the wake channel was cleared.\"}},\"required\":[\"pushCapable\"],\"title\":\"Device Set Wake — response payload\",\"type\":\"object\"},\"WakeHandle\":{\"additionalProperties\":false,\"description\":\"An opaque, gateway-issued reference to a device's push channel (push wake-up binding, https://trusttasks.org/binding/push/0.1). The push gateway returns it to the device at registration; the device conveys it to its VTA (device/set-wake), and the VTA provisions it to authorized triggers (its mediator and/or itself). The raw platform push token (APNs/FCM/WebPush) is held ONLY by the gateway and is never represented here — the handle abstracts the platform, so adding new push methods (e.g. PWA Web Push) needs no change to triggers or VTA config. A handle is a bearer capability to *request* a wake (subject to the gateway's allowlist), never to read the channel.\",\"properties\":{\"gateway\":{\"description\":\"The push gateway that issued this handle and acts on it — a DID (DIDComm-reachable gateway) or an https URL (REST gateway). A trigger sends its contentless wake request here.\",\"minLength\":1,\"type\":\"string\"},\"handle\":{\"description\":\"Opaque gateway-issued identifier for the device's push channel. Reveals no platform token. Rotates whenever the device re-registers a new platform token with the gateway; the device then re-conveys the fresh handle via device/set-wake.\",\"minLength\":1,\"type\":\"string\"}},\"required\":[\"gateway\",\"handle\"],\"title\":\"WakeHandle\",\"type\":\"object\"},\"WakeTriggerPolicy\":{\"additionalProperties\":false,\"description\":\"VTA-owned allowlist of the DIDs permitted to trigger a wake for a given WakeHandle (push wake-up binding, https://trusttasks.org/binding/push/0.1). The VTA is the source of truth for this policy — all device config state resides at the VTA — and provisions it to the gateway, which ENFORCES it: a wake request from a DID not on the list is refused. Typically holds the device's mediator DID (queue-driven wake, where the mediator alone knows the device is offline) and/or the VTA's own DID (policy-driven wake, e.g. a step-up the VTA is delegating to this device).\",\"properties\":{\"allowedTriggers\":{\"description\":\"DIDs authorized to trigger a wake for this handle. An empty array means no party may wake the device (push effectively disabled while the handle exists). The gateway authenticates the trigger's DID before checking membership.\",\"items\":{\"minLength\":1,\"type\":\"string\"},\"type\":\"array\",\"uniqueItems\":true}},\"required\":[\"allowedTriggers\"],\"title\":\"WakeTriggerPolicy\",\"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_REGISTERED,
error_codes::INVALID_HANDLE,
error_codes::GATEWAY_UNREACHABLE,
];
/// 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 {
/// `device/set-wake:notRegistered`
///
/// The issuer's DID has no DeviceBinding. The device MUST complete device/register before setting a wake channel.
///
/// Declared `retryable: false`.
pub const NOT_REGISTERED: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "device/set-wake:notRegistered",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `device/set-wake:invalidHandle`
///
/// The supplied WakeHandle is malformed, or the named gateway rejected it as unknown/expired when the VTA attempted to provision the allowlist.
///
/// Declared `retryable: false`.
pub const INVALID_HANDLE: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "device/set-wake:invalidHandle",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `device/set-wake:gatewayUnreachable`
///
/// The VTA could not reach or authenticate to the named push gateway to provision the trigger allowlist. The handle is not recorded; the device SHOULD retry.
///
/// Declared `retryable: true`.
pub const GATEWAY_UNREACHABLE: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "device/set-wake:gatewayUnreachable",
retryable: true,
details_schema: ::core::option::Option::None,
};
}