//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `vtc/admin/events/subscribe`. Version: `0.1`.
#[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.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Ext",
/// "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.",
/// "type": "object",
/// "minProperties": 1,
/// "additionalProperties": true,
/// "propertyNames": {
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
/// }
///}
/// ```
/// </details>
#[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`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
///}
/// ```
/// </details>
#[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())
})
}
}
///Open an administrator console's live channel of hint-only events. The success response is the first document on a stream that then carries vtc/admin/events/event/0.1 documents; over HTTPS that stream is the streamed response of bindings/https/0.3 §2.1. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/vtc/admin/events/subscribe/0.1",
/// "title": "Payload",
/// "description": "Open an administrator console's live channel of hint-only events. The success response is the first document on a stream that then carries vtc/admin/events/event/0.1 documents; over HTTPS that stream is the streamed response of bindings/https/0.3 §2.1. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
/// "type": "object",
/// "required": [
/// "topics"
/// ],
/// "properties": {
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "since": {
/// "description": "The last `resumeToken` the console received on an earlier stream, to resume from. A token the community does not recognise, has expired, or minted for another caller is not an error: the stream starts fresh and the response says `resumed: false`.",
/// "$ref": "#/definitions/ResumeToken"
/// },
/// "topics": {
/// "description": "The topics the console renders. The community narrows this to the topics the caller may read and reports the result as the response's `topics`.",
/// "type": "array",
/// "items": {
/// "$ref": "#/definitions/Topic"
/// },
/// "maxItems": 6,
/// "minItems": 1,
/// "uniqueItems": true
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[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>,
///The last `resumeToken` the console received on an earlier stream, to resume from. A token the community does not recognise, has expired, or minted for another caller is not an error: the stream starts fresh and the response says `resumed: false`.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub since: ::std::option::Option<ResumeToken>,
///The topics the console renders. The community narrows this to the topics the caller may read and reports the result as the response's `topics`.
pub topics: Vec<Topic>,
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "description": "The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.",
/// "type": "object",
/// "required": [
/// "heartbeatSeconds",
/// "resumeToken",
/// "resumed",
/// "topics"
/// ],
/// "properties": {
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "heartbeatSeconds": {
/// "description": "The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead.",
/// "type": "integer",
/// "maximum": 60.0,
/// "minimum": 5.0
/// },
/// "resumeToken": {
/// "description": "The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from.",
/// "$ref": "#/definitions/ResumeToken"
/// },
/// "resumed": {
/// "description": "`true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes.",
/// "type": "boolean"
/// },
/// "topics": {
/// "description": "The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live.",
/// "type": "array",
/// "items": {
/// "$ref": "#/definitions/Topic"
/// },
/// "maxItems": 6,
/// "minItems": 1,
/// "uniqueItems": true
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[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>,
///The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead.
#[serde(rename = "heartbeatSeconds")]
pub heartbeat_seconds: i64,
///The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from.
#[serde(rename = "resumeToken")]
pub resume_token: ResumeToken,
///`true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes.
pub resumed: bool,
///The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live.
pub topics: Vec<Topic>,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "ResumeToken",
/// "description": "Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.",
/// "type": "string",
/// "maxLength": 256,
/// "minLength": 1,
/// "pattern": "^[A-Za-z0-9._~-]+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ResumeToken(::std::string::String);
impl ::std::ops::Deref for ResumeToken {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResumeToken> for ::std::string::String {
fn from(value: ResumeToken) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResumeToken {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 256usize {
return Err("longer than 256 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^[A-Za-z0-9._~-]+$").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[A-Za-z0-9._~-]+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ResumeToken {
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 ResumeToken {
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 ResumeToken {
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 ResumeToken {
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())
})
}
}
///One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Topic",
/// "description": "One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.",
/// "type": "string",
/// "enum": [
/// "actions",
/// "acknowledgements",
/// "joinRequests",
/// "members",
/// "singleAdminMode",
/// "config"
/// ]
///}
/// ```
/// </details>
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
#[non_exhaustive]
pub enum Topic {
#[serde(rename = "actions")]
Actions,
#[serde(rename = "acknowledgements")]
Acknowledgements,
#[serde(rename = "joinRequests")]
JoinRequests,
#[serde(rename = "members")]
Members,
#[serde(rename = "singleAdminMode")]
SingleAdminMode,
#[serde(rename = "config")]
Config,
}
impl ::std::fmt::Display for Topic {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::Actions => f.write_str("actions"),
Self::Acknowledgements => f.write_str("acknowledgements"),
Self::JoinRequests => f.write_str("joinRequests"),
Self::Members => f.write_str("members"),
Self::SingleAdminMode => f.write_str("singleAdminMode"),
Self::Config => f.write_str("config"),
}
}
}
impl ::std::str::FromStr for Topic {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"actions" => Ok(Self::Actions),
"acknowledgements" => Ok(Self::Acknowledgements),
"joinRequests" => Ok(Self::JoinRequests),
"members" => Ok(Self::Members),
"singleAdminMode" => Ok(Self::SingleAdminMode),
"config" => Ok(Self::Config),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for Topic {
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 Topic {
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 Topic {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
/// 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>,
since:
::std::result::Result<::std::option::Option<super::ResumeToken>, ::std::string::String>,
topics: ::std::result::Result<Vec<super::Topic>, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
since: Ok(Default::default()),
topics: Err("no value supplied for topics".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 since<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::ResumeToken>>,
T::Error: ::std::fmt::Display,
{
self.since = value
.try_into()
.map_err(|e| format!("error converting supplied value for since: {e}"));
self
}
pub fn topics<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<Vec<super::Topic>>,
T::Error: ::std::fmt::Display,
{
self.topics = value
.try_into()
.map_err(|e| format!("error converting supplied value for topics: {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?,
since: value.since?,
topics: value.topics?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
ext: Ok(value.ext),
since: Ok(value.since),
topics: Ok(value.topics),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
heartbeat_seconds: ::std::result::Result<i64, ::std::string::String>,
resume_token: ::std::result::Result<super::ResumeToken, ::std::string::String>,
resumed: ::std::result::Result<bool, ::std::string::String>,
topics: ::std::result::Result<Vec<super::Topic>, ::std::string::String>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
heartbeat_seconds: Err("no value supplied for heartbeat_seconds".to_string()),
resume_token: Err("no value supplied for resume_token".to_string()),
resumed: Err("no value supplied for resumed".to_string()),
topics: Err("no value supplied for topics".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 heartbeat_seconds<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<i64>,
T::Error: ::std::fmt::Display,
{
self.heartbeat_seconds = value
.try_into()
.map_err(|e| format!("error converting supplied value for heartbeat_seconds: {e}"));
self
}
pub fn resume_token<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ResumeToken>,
T::Error: ::std::fmt::Display,
{
self.resume_token = value
.try_into()
.map_err(|e| format!("error converting supplied value for resume_token: {e}"));
self
}
pub fn resumed<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<bool>,
T::Error: ::std::fmt::Display,
{
self.resumed = value
.try_into()
.map_err(|e| format!("error converting supplied value for resumed: {e}"));
self
}
pub fn topics<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<Vec<super::Topic>>,
T::Error: ::std::fmt::Display,
{
self.topics = value
.try_into()
.map_err(|e| format!("error converting supplied value for topics: {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?,
heartbeat_seconds: value.heartbeat_seconds?,
resume_token: value.resume_token?,
resumed: value.resumed?,
topics: value.topics?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
ext: Ok(value.ext),
heartbeat_seconds: Ok(value.heartbeat_seconds),
resume_token: Ok(value.resume_token),
resumed: Ok(value.resumed),
topics: Ok(value.topics),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vtc/admin/events/subscribe/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(
"{\n \"$defs\": {\n \"Ext\": {\n \"additionalProperties\": true,\n \"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.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"heartbeatSeconds\": {\n \"description\": \"The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead.\",\n \"maximum\": 60,\n \"minimum\": 5,\n \"type\": \"integer\"\n },\n \"resumeToken\": {\n \"$ref\": \"#/$defs/ResumeToken\",\n \"description\": \"The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from.\"\n },\n \"resumed\": {\n \"description\": \"`true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes.\",\n \"type\": \"boolean\"\n },\n \"topics\": {\n \"description\": \"The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live.\",\n \"items\": {\n \"$ref\": \"#/$defs/Topic\"\n },\n \"maxItems\": 6,\n \"minItems\": 1,\n \"type\": \"array\",\n \"uniqueItems\": true\n }\n },\n \"required\": [\n \"topics\",\n \"heartbeatSeconds\",\n \"resumed\",\n \"resumeToken\"\n ],\n \"title\": \"VTC Admin Events — Subscribe — response payload\",\n \"type\": \"object\"\n },\n \"ResumeToken\": {\n \"description\": \"Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.\",\n \"maxLength\": 256,\n \"minLength\": 1,\n \"pattern\": \"^[A-Za-z0-9._~-]+$\",\n \"title\": \"ResumeToken\",\n \"type\": \"string\"\n },\n \"Topic\": {\n \"description\": \"One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.\",\n \"enum\": [\n \"actions\",\n \"acknowledgements\",\n \"joinRequests\",\n \"members\",\n \"singleAdminMode\",\n \"config\"\n ],\n \"title\": \"Topic\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/vtc/admin/events/subscribe/0.1\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"Open an administrator console's live channel of hint-only events. The success response is the first document on a stream that then carries vtc/admin/events/event/0.1 documents; over HTTPS that stream is the streamed response of bindings/https/0.3 §2.1. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"since\": {\n \"$ref\": \"#/$defs/ResumeToken\",\n \"description\": \"The last `resumeToken` the console received on an earlier stream, to resume from. A token the community does not recognise, has expired, or minted for another caller is not an error: the stream starts fresh and the response says `resumed: false`.\"\n },\n \"topics\": {\n \"description\": \"The topics the console renders. The community narrows this to the topics the caller may read and reports the result as the response's `topics`.\",\n \"items\": {\n \"$ref\": \"#/$defs/Topic\"\n },\n \"maxItems\": 6,\n \"minItems\": 1,\n \"type\": \"array\",\n \"uniqueItems\": true\n }\n },\n \"required\": [\n \"topics\"\n ],\n \"title\": \"VTC Admin Events — Subscribe — payload\",\n \"type\": \"object\"\n}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str =
"https://trusttasks.org/spec/vtc/admin/events/subscribe/0.1#response";
const IS_ISSUED_AT_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\n \"$defs\": {\n \"Ext\": {\n \"additionalProperties\": true,\n \"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.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"heartbeatSeconds\": {\n \"description\": \"The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead.\",\n \"maximum\": 60,\n \"minimum\": 5,\n \"type\": \"integer\"\n },\n \"resumeToken\": {\n \"$ref\": \"#/$defs/ResumeToken\",\n \"description\": \"The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from.\"\n },\n \"resumed\": {\n \"description\": \"`true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes.\",\n \"type\": \"boolean\"\n },\n \"topics\": {\n \"description\": \"The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live.\",\n \"items\": {\n \"$ref\": \"#/$defs/Topic\"\n },\n \"maxItems\": 6,\n \"minItems\": 1,\n \"type\": \"array\",\n \"uniqueItems\": true\n }\n },\n \"required\": [\n \"topics\",\n \"heartbeatSeconds\",\n \"resumed\",\n \"resumeToken\"\n ],\n \"title\": \"VTC Admin Events — Subscribe — response payload\",\n \"type\": \"object\"\n },\n \"ResumeToken\": {\n \"description\": \"Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.\",\n \"maxLength\": 256,\n \"minLength\": 1,\n \"pattern\": \"^[A-Za-z0-9._~-]+$\",\n \"title\": \"ResumeToken\",\n \"type\": \"string\"\n },\n \"Topic\": {\n \"description\": \"One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.\",\n \"enum\": [\n \"actions\",\n \"acknowledgements\",\n \"joinRequests\",\n \"members\",\n \"singleAdminMode\",\n \"config\"\n ],\n \"title\": \"Topic\",\n \"type\": \"string\"\n }\n },\n \"$ref\": \"#/$defs/Response\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\"\n}\n",
);
}
impl crate::RequestPayload for Payload {
type Response = Response;
}
/// 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_ADMINISTRATOR,
error_codes::STREAM_UNAVAILABLE,
error_codes::TOO_MANY_STREAMS,
];
/// 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 {
/// `vtc/admin/events/subscribe:notAdministrator`
///
/// The proven caller holds no administrative role at this community.
///
/// Declared `retryable: false`.
pub const NOT_ADMINISTRATOR: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vtc/admin/events/subscribe:notAdministrator",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `vtc/admin/events/subscribe:streamUnavailable`
///
/// The request did not arrive over a delivery that can carry a stream — over HTTPS, a request without `Accept: text/event-stream`, or a binding that defines no streamed response. The console falls back to polling.
///
/// Declared `retryable: false`.
pub const STREAM_UNAVAILABLE: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vtc/admin/events/subscribe:streamUnavailable",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `vtc/admin/events/subscribe:tooManyStreams`
///
/// The caller already holds as many open streams as the community allows. Close one (another tab or device), or poll.
///
/// Declared `retryable: true`.
pub const TOO_MANY_STREAMS: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vtc/admin/events/subscribe:tooManyStreams",
retryable: true,
details_schema: ::core::option::Option::None,
};
}