//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `rooms/keys/list`. Version: `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.
///
/// <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())
})
}
}
///List the rooms the key holder can open for members the caller may act as. `includePersonal` asks for each entry's personal label as well; absent, none is returned. Carries no filter: the recipient answers for the members its caller acts as, and there is nothing to ask it about. The outer document members are owned by the framework — SPEC §6.3.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/rooms/keys/list/0.2",
/// "title": "Payload",
/// "description": "List the rooms the key holder can open for members the caller may act as. `includePersonal` asks for each entry's personal label as well; absent, none is returned. Carries no filter: the recipient answers for the members its caller acts as, and there is nothing to ask it about. The outer document members are owned by the framework — SPEC §6.3.",
/// "type": "object",
/// "properties": {
/// "ext": {
/// "description": "Ecosystem-defined extension members per SPEC.md §4.5.1.",
/// "$ref": "#/definitions/Ext"
/// },
/// "includePersonal": {
/// "description": "`true` asks for each entry's personal label (rooms/keys/label) in `personal`. Absent or `false`: no entry carries one. A request option, not a filter — it changes which members of an entry are returned, never which entries — and off by default so that a caller that has no use for the member's own names, or will pass the list on, never receives them.",
/// "type": "boolean"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Payload {
///Ecosystem-defined extension members per SPEC.md §4.5.1.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///`true` asks for each entry's personal label (rooms/keys/label) in `personal`. Absent or `false`: no entry carries one. A request option, not a filter — it changes which members of an entry are returned, never which entries — and off by default so that a caller that has no use for the member's own names, or will pass the list on, never receives them.
#[serde(
rename = "includePersonal",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub include_personal: ::std::option::Option<bool>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Default::default(),
include_personal: Default::default(),
}
}
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///A member's personal label for one room, as their key holder keeps it: at least one detail (`minProperties` counts `updatedAt`), and when it last changed. A key holder that holds no detail for the room holds no label, and returns none — there is no empty label.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "PersonalLabel",
/// "description": "A member's personal label for one room, as their key holder keeps it: at least one detail (`minProperties` counts `updatedAt`), and when it last changed. A key holder that holds no detail for the room holds no label, and returns none — there is no empty label.",
/// "type": "object",
/// "minProperties": 2,
/// "required": [
/// "updatedAt"
/// ],
/// "properties": {
/// "description": {
/// "$ref": "#/definitions/PersonalLabelDescription"
/// },
/// "label": {
/// "$ref": "#/definitions/PersonalLabelName"
/// },
/// "notes": {
/// "$ref": "#/definitions/PersonalLabelNotes"
/// },
/// "tags": {
/// "$ref": "#/definitions/PersonalLabelTags"
/// },
/// "updatedAt": {
/// "description": "When the label last changed, as the key holder recorded it. A request that changed nothing does not move it.",
/// "type": "string",
/// "format": "date-time"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct PersonalLabel {
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub description: ::std::option::Option<PersonalLabelDescription>,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub label: ::std::option::Option<PersonalLabelName>,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub notes: ::std::option::Option<PersonalLabelNotes>,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub tags: ::std::option::Option<PersonalLabelTags>,
///When the label last changed, as the key holder recorded it. A request that changed nothing does not move it.
#[serde(rename = "updatedAt")]
pub updated_at: ::chrono::DateTime<::chrono::offset::Utc>,
}
impl PersonalLabel {
pub fn builder() -> builder::PersonalLabel {
Default::default()
}
}
///What the room is to the member, in a sentence or a short paragraph. Line breaks and tabs are allowed; other control characters are not.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "PersonalLabelDescription",
/// "description": "What the room is to the member, in a sentence or a short paragraph. Line breaks and tabs are allowed; other control characters are not.",
/// "type": "string",
/// "maxLength": 1000,
/// "minLength": 1,
/// "pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PersonalLabelDescription(::std::string::String);
impl ::std::ops::Deref for PersonalLabelDescription {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PersonalLabelDescription> for ::std::string::String {
fn from(value: PersonalLabelDescription) -> Self {
value.0
}
}
impl ::std::str::FromStr for PersonalLabelDescription {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 1000usize {
return Err("longer than 1000 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("^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$")
.unwrap()
});
if PATTERN.find(value).is_none() {
return Err(
"doesn't match pattern \"^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$\""
.into(),
);
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PersonalLabelDescription {
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 PersonalLabelDescription {
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 PersonalLabelDescription {
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 PersonalLabelDescription {
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())
})
}
}
///The member's own name for the room, on one line: no control characters, line breaks included. Shown before every name a third party gave the room, because it is the only one nobody else wrote.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "PersonalLabelName",
/// "description": "The member's own name for the room, on one line: no control characters, line breaks included. Shown before every name a third party gave the room, because it is the only one nobody else wrote.",
/// "type": "string",
/// "maxLength": 128,
/// "minLength": 1,
/// "pattern": "^[^\\u0000-\\u001F\\u007F]+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PersonalLabelName(::std::string::String);
impl ::std::ops::Deref for PersonalLabelName {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PersonalLabelName> for ::std::string::String {
fn from(value: PersonalLabelName) -> Self {
value.0
}
}
impl ::std::str::FromStr for PersonalLabelName {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 128usize {
return Err("longer than 128 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("^[^\\u0000-\\u001F\\u007F]+$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[^\\u0000-\\u001F\\u007F]+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PersonalLabelName {
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 PersonalLabelName {
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 PersonalLabelName {
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 PersonalLabelName {
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())
})
}
}
///Longer free-form notes the member keeps about the room: who introduced them, what to look for in it, what they agreed there. Line breaks and tabs are allowed; other control characters are not.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "PersonalLabelNotes",
/// "description": "Longer free-form notes the member keeps about the room: who introduced them, what to look for in it, what they agreed there. Line breaks and tabs are allowed; other control characters are not.",
/// "type": "string",
/// "maxLength": 4000,
/// "minLength": 1,
/// "pattern": "^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PersonalLabelNotes(::std::string::String);
impl ::std::ops::Deref for PersonalLabelNotes {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PersonalLabelNotes> for ::std::string::String {
fn from(value: PersonalLabelNotes) -> Self {
value.0
}
}
impl ::std::str::FromStr for PersonalLabelNotes {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 4000usize {
return Err("longer than 4000 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("^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$")
.unwrap()
});
if PATTERN.find(value).is_none() {
return Err(
"doesn't match pattern \"^[^\\u0000-\\u0008\\u000B\\u000C\\u000E-\\u001F\\u007F]+$\""
.into(),
);
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PersonalLabelNotes {
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 PersonalLabelNotes {
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 PersonalLabelNotes {
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 PersonalLabelNotes {
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 word or short phrase the member files the room under, in any script, so their own surfaces can group and filter their rooms. Compared exactly, as a string: a key holder does not case-fold or normalise it.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "PersonalLabelTag",
/// "description": "A word or short phrase the member files the room under, in any script, so their own surfaces can group and filter their rooms. Compared exactly, as a string: a key holder does not case-fold or normalise it.",
/// "type": "string",
/// "maxLength": 32,
/// "minLength": 1,
/// "pattern": "^[^\\u0000-\\u001F\\u007F]+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PersonalLabelTag(::std::string::String);
impl ::std::ops::Deref for PersonalLabelTag {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PersonalLabelTag> for ::std::string::String {
fn from(value: PersonalLabelTag) -> Self {
value.0
}
}
impl ::std::str::FromStr for PersonalLabelTag {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 32usize {
return Err("longer than 32 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("^[^\\u0000-\\u001F\\u007F]+$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[^\\u0000-\\u001F\\u007F]+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PersonalLabelTag {
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 PersonalLabelTag {
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 PersonalLabelTag {
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 PersonalLabelTag {
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())
})
}
}
///The member's tags for the room, one to sixteen, as a set: order carries no meaning. A room with no tags has no `tags` member, never an empty list, so there is one way to say "none".
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "PersonalLabelTags",
/// "description": "The member's tags for the room, one to sixteen, as a set: order carries no meaning. A room with no tags has no `tags` member, never an empty list, so there is one way to say \"none\".",
/// "type": "array",
/// "items": {
/// "$ref": "#/definitions/PersonalLabelTag"
/// },
/// "maxItems": 16,
/// "minItems": 1,
/// "uniqueItems": true
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct PersonalLabelTags(pub Vec<PersonalLabelTag>);
impl ::std::ops::Deref for PersonalLabelTags {
type Target = Vec<PersonalLabelTag>;
fn deref(&self) -> &Vec<PersonalLabelTag> {
&self.0
}
}
impl ::std::convert::From<PersonalLabelTags> for Vec<PersonalLabelTag> {
fn from(value: PersonalLabelTags) -> Self {
value.0
}
}
impl ::std::convert::From<Vec<PersonalLabelTag>> for PersonalLabelTags {
fn from(value: Vec<PersonalLabelTag>) -> Self {
Self(value)
}
}
///Success response to rooms/keys/list. Type https://trusttasks.org/spec/rooms/keys/list/0.2#response. The rooms this key holder can open, one entry per room and member, for the members the caller may act as. This is key custody, not membership: a room whose group state was never delivered is absent here and the member may still hold a perfectly good VMC for it.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "description": "Success response to rooms/keys/list. Type https://trusttasks.org/spec/rooms/keys/list/0.2#response. The rooms this key holder can open, one entry per room and member, for the members the caller may act as. This is key custody, not membership: a room whose group state was never delivered is absent here and the member may still hold a perfectly good VMC for it.",
/// "type": "object",
/// "required": [
/// "rooms"
/// ],
/// "properties": {
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "rooms": {
/// "description": "One entry per room and member, in no guaranteed order. A room held as two members the caller may act as appears twice, once per member.",
/// "type": "array",
/// "items": {
/// "type": "object",
/// "required": [
/// "earliestReadableEpoch",
/// "epoch",
/// "member",
/// "roomId"
/// ],
/// "properties": {
/// "earliestReadableEpoch": {
/// "description": "The earliest epoch this key holder can derive a key for, for this member, walking the epoch key chain it holds. Equal to `epoch` means it reads only from where it joined; `1` means the room's whole retained history. Anything between is a chain that has been delivered in part, or one deliberately severed below that point.",
/// "type": "integer",
/// "minimum": 1.0
/// },
/// "epoch": {
/// "description": "The epoch this key holder is at for this member. Behind the room's own epoch means a commit has not been delivered, and records sealed since will not open.",
/// "type": "integer",
/// "minimum": 1.0
/// },
/// "member": {
/// "description": "The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.",
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
/// },
/// "personal": {
/// "description": "The member's own label for the room (rooms/keys/label). Present only when the request set `includePersonal: true` and the member has one. Private to the member: a caller MUST NOT pass it to the room's host, its owner, a community or a website the member has not chosen to show it to.",
/// "$ref": "#/definitions/PersonalLabel"
/// },
/// "roomId": {
/// "description": "The room's identifier.",
/// "type": "string",
/// "maxLength": 512,
/// "minLength": 1
/// }
/// },
/// "additionalProperties": false
/// }
/// }
/// },
/// "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>,
///One entry per room and member, in no guaranteed order. A room held as two members the caller may act as appears twice, once per member.
pub rooms: ::std::vec::Vec<ResponseRoomsItem>,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///`ResponseRoomsItem`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "object",
/// "required": [
/// "earliestReadableEpoch",
/// "epoch",
/// "member",
/// "roomId"
/// ],
/// "properties": {
/// "earliestReadableEpoch": {
/// "description": "The earliest epoch this key holder can derive a key for, for this member, walking the epoch key chain it holds. Equal to `epoch` means it reads only from where it joined; `1` means the room's whole retained history. Anything between is a chain that has been delivered in part, or one deliberately severed below that point.",
/// "type": "integer",
/// "minimum": 1.0
/// },
/// "epoch": {
/// "description": "The epoch this key holder is at for this member. Behind the room's own epoch means a commit has not been delivered, and records sealed since will not open.",
/// "type": "integer",
/// "minimum": 1.0
/// },
/// "member": {
/// "description": "The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.",
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
/// },
/// "personal": {
/// "description": "The member's own label for the room (rooms/keys/label). Present only when the request set `includePersonal: true` and the member has one. Private to the member: a caller MUST NOT pass it to the room's host, its owner, a community or a website the member has not chosen to show it to.",
/// "$ref": "#/definitions/PersonalLabel"
/// },
/// "roomId": {
/// "description": "The room's identifier.",
/// "type": "string",
/// "maxLength": 512,
/// "minLength": 1
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct ResponseRoomsItem {
///The earliest epoch this key holder can derive a key for, for this member, walking the epoch key chain it holds. Equal to `epoch` means it reads only from where it joined; `1` means the room's whole retained history. Anything between is a chain that has been delivered in part, or one deliberately severed below that point.
#[serde(rename = "earliestReadableEpoch")]
pub earliest_readable_epoch: ::std::num::NonZeroU64,
///The epoch this key holder is at for this member. Behind the room's own epoch means a commit has not been delivered, and records sealed since will not open.
pub epoch: ::std::num::NonZeroU64,
///The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.
pub member: ResponseRoomsItemMember,
///The member's own label for the room (rooms/keys/label). Present only when the request set `includePersonal: true` and the member has one. Private to the member: a caller MUST NOT pass it to the room's host, its owner, a community or a website the member has not chosen to show it to.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub personal: ::std::option::Option<PersonalLabel>,
///The room's identifier.
#[serde(rename = "roomId")]
pub room_id: ResponseRoomsItemRoomId,
}
impl ResponseRoomsItem {
pub fn builder() -> builder::ResponseRoomsItem {
Default::default()
}
}
///The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.",
/// "type": "string",
/// "maxLength": 2048,
/// "pattern": "^did:"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ResponseRoomsItemMember(::std::string::String);
impl ::std::ops::Deref for ResponseRoomsItemMember {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResponseRoomsItemMember> for ::std::string::String {
fn from(value: ResponseRoomsItemMember) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResponseRoomsItemMember {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 2048usize {
return Err("longer than 2048 characters".into());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^did:").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^did:\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ResponseRoomsItemMember {
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 ResponseRoomsItemMember {
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 ResponseRoomsItemMember {
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 ResponseRoomsItemMember {
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())
})
}
}
///The room's identifier.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The room's identifier.",
/// "type": "string",
/// "maxLength": 512,
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ResponseRoomsItemRoomId(::std::string::String);
impl ::std::ops::Deref for ResponseRoomsItemRoomId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ResponseRoomsItemRoomId> for ::std::string::String {
fn from(value: ResponseRoomsItemRoomId) -> Self {
value.0
}
}
impl ::std::str::FromStr for ResponseRoomsItemRoomId {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 512usize {
return Err("longer than 512 characters".into());
}
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ResponseRoomsItemRoomId {
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 ResponseRoomsItemRoomId {
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 ResponseRoomsItemRoomId {
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 ResponseRoomsItemRoomId {
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>,
include_personal: ::std::result::Result<::std::option::Option<bool>, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
include_personal: 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 include_personal<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<bool>>,
T::Error: ::std::fmt::Display,
{
self.include_personal = value
.try_into()
.map_err(|e| format!("error converting supplied value for include_personal: {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?,
include_personal: value.include_personal?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
ext: Ok(value.ext),
include_personal: Ok(value.include_personal),
}
}
}
#[derive(Clone, Debug)]
pub struct PersonalLabel {
description: ::std::result::Result<
::std::option::Option<super::PersonalLabelDescription>,
::std::string::String,
>,
label: ::std::result::Result<
::std::option::Option<super::PersonalLabelName>,
::std::string::String,
>,
notes: ::std::result::Result<
::std::option::Option<super::PersonalLabelNotes>,
::std::string::String,
>,
tags: ::std::result::Result<
::std::option::Option<super::PersonalLabelTags>,
::std::string::String,
>,
updated_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
}
impl ::std::default::Default for PersonalLabel {
fn default() -> Self {
Self {
description: Ok(Default::default()),
label: Ok(Default::default()),
notes: Ok(Default::default()),
tags: Ok(Default::default()),
updated_at: Err("no value supplied for updated_at".to_string()),
}
}
}
impl PersonalLabel {
pub fn description<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::PersonalLabelDescription>>,
T::Error: ::std::fmt::Display,
{
self.description = value
.try_into()
.map_err(|e| format!("error converting supplied value for description: {e}"));
self
}
pub fn label<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::PersonalLabelName>>,
T::Error: ::std::fmt::Display,
{
self.label = value
.try_into()
.map_err(|e| format!("error converting supplied value for label: {e}"));
self
}
pub fn notes<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::PersonalLabelNotes>>,
T::Error: ::std::fmt::Display,
{
self.notes = value
.try_into()
.map_err(|e| format!("error converting supplied value for notes: {e}"));
self
}
pub fn tags<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::PersonalLabelTags>>,
T::Error: ::std::fmt::Display,
{
self.tags = value
.try_into()
.map_err(|e| format!("error converting supplied value for tags: {e}"));
self
}
pub fn updated_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::chrono::DateTime<::chrono::offset::Utc>>,
T::Error: ::std::fmt::Display,
{
self.updated_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for updated_at: {e}"));
self
}
}
impl ::std::convert::TryFrom<PersonalLabel> for super::PersonalLabel {
type Error = super::error::ConversionError;
fn try_from(
value: PersonalLabel,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
description: value.description?,
label: value.label?,
notes: value.notes?,
tags: value.tags?,
updated_at: value.updated_at?,
})
}
}
impl ::std::convert::From<super::PersonalLabel> for PersonalLabel {
fn from(value: super::PersonalLabel) -> Self {
Self {
description: Ok(value.description),
label: Ok(value.label),
notes: Ok(value.notes),
tags: Ok(value.tags),
updated_at: Ok(value.updated_at),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
rooms:
::std::result::Result<::std::vec::Vec<super::ResponseRoomsItem>, ::std::string::String>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
ext: Ok(Default::default()),
rooms: Err("no value supplied for rooms".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 rooms<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::vec::Vec<super::ResponseRoomsItem>>,
T::Error: ::std::fmt::Display,
{
self.rooms = value
.try_into()
.map_err(|e| format!("error converting supplied value for rooms: {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?,
rooms: value.rooms?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
ext: Ok(value.ext),
rooms: Ok(value.rooms),
}
}
}
#[derive(Clone, Debug)]
pub struct ResponseRoomsItem {
earliest_readable_epoch:
::std::result::Result<::std::num::NonZeroU64, ::std::string::String>,
epoch: ::std::result::Result<::std::num::NonZeroU64, ::std::string::String>,
member: ::std::result::Result<super::ResponseRoomsItemMember, ::std::string::String>,
personal: ::std::result::Result<
::std::option::Option<super::PersonalLabel>,
::std::string::String,
>,
room_id: ::std::result::Result<super::ResponseRoomsItemRoomId, ::std::string::String>,
}
impl ::std::default::Default for ResponseRoomsItem {
fn default() -> Self {
Self {
earliest_readable_epoch: Err(
"no value supplied for earliest_readable_epoch".to_string()
),
epoch: Err("no value supplied for epoch".to_string()),
member: Err("no value supplied for member".to_string()),
personal: Ok(Default::default()),
room_id: Err("no value supplied for room_id".to_string()),
}
}
}
impl ResponseRoomsItem {
pub fn earliest_readable_epoch<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::num::NonZeroU64>,
T::Error: ::std::fmt::Display,
{
self.earliest_readable_epoch = value.try_into().map_err(|e| {
format!("error converting supplied value for earliest_readable_epoch: {e}")
});
self
}
pub fn epoch<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::num::NonZeroU64>,
T::Error: ::std::fmt::Display,
{
self.epoch = value
.try_into()
.map_err(|e| format!("error converting supplied value for epoch: {e}"));
self
}
pub fn member<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ResponseRoomsItemMember>,
T::Error: ::std::fmt::Display,
{
self.member = value
.try_into()
.map_err(|e| format!("error converting supplied value for member: {e}"));
self
}
pub fn personal<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::PersonalLabel>>,
T::Error: ::std::fmt::Display,
{
self.personal = value
.try_into()
.map_err(|e| format!("error converting supplied value for personal: {e}"));
self
}
pub fn room_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::ResponseRoomsItemRoomId>,
T::Error: ::std::fmt::Display,
{
self.room_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for room_id: {e}"));
self
}
}
impl ::std::convert::TryFrom<ResponseRoomsItem> for super::ResponseRoomsItem {
type Error = super::error::ConversionError;
fn try_from(
value: ResponseRoomsItem,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
earliest_readable_epoch: value.earliest_readable_epoch?,
epoch: value.epoch?,
member: value.member?,
personal: value.personal?,
room_id: value.room_id?,
})
}
}
impl ::std::convert::From<super::ResponseRoomsItem> for ResponseRoomsItem {
fn from(value: super::ResponseRoomsItem) -> Self {
Self {
earliest_readable_epoch: Ok(value.earliest_readable_epoch),
epoch: Ok(value.epoch),
member: Ok(value.member),
personal: Ok(value.personal),
room_id: Ok(value.room_id),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/rooms/keys/list/0.2";
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 \"PersonalLabel\": {\n \"additionalProperties\": false,\n \"description\": \"A member's personal label for one room, as their key holder keeps it: at least one detail (`minProperties` counts `updatedAt`), and when it last changed. A key holder that holds no detail for the room holds no label, and returns none — there is no empty label.\",\n \"minProperties\": 2,\n \"properties\": {\n \"description\": {\n \"$ref\": \"#/$defs/PersonalLabelDescription\"\n },\n \"label\": {\n \"$ref\": \"#/$defs/PersonalLabelName\"\n },\n \"notes\": {\n \"$ref\": \"#/$defs/PersonalLabelNotes\"\n },\n \"tags\": {\n \"$ref\": \"#/$defs/PersonalLabelTags\"\n },\n \"updatedAt\": {\n \"description\": \"When the label last changed, as the key holder recorded it. A request that changed nothing does not move it.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"updatedAt\"\n ],\n \"title\": \"PersonalLabel\",\n \"type\": \"object\"\n },\n \"PersonalLabelDescription\": {\n \"description\": \"What the room is to the member, in a sentence or a short paragraph. Line breaks and tabs are allowed; other control characters are not.\",\n \"maxLength\": 1000,\n \"minLength\": 1,\n \"pattern\": \"^[^\\\\u0000-\\\\u0008\\\\u000B\\\\u000C\\\\u000E-\\\\u001F\\\\u007F]+$\",\n \"title\": \"PersonalLabelDescription\",\n \"type\": \"string\"\n },\n \"PersonalLabelName\": {\n \"description\": \"The member's own name for the room, on one line: no control characters, line breaks included. Shown before every name a third party gave the room, because it is the only one nobody else wrote.\",\n \"maxLength\": 128,\n \"minLength\": 1,\n \"pattern\": \"^[^\\\\u0000-\\\\u001F\\\\u007F]+$\",\n \"title\": \"PersonalLabelName\",\n \"type\": \"string\"\n },\n \"PersonalLabelNotes\": {\n \"description\": \"Longer free-form notes the member keeps about the room: who introduced them, what to look for in it, what they agreed there. Line breaks and tabs are allowed; other control characters are not.\",\n \"maxLength\": 4000,\n \"minLength\": 1,\n \"pattern\": \"^[^\\\\u0000-\\\\u0008\\\\u000B\\\\u000C\\\\u000E-\\\\u001F\\\\u007F]+$\",\n \"title\": \"PersonalLabelNotes\",\n \"type\": \"string\"\n },\n \"PersonalLabelTag\": {\n \"description\": \"A word or short phrase the member files the room under, in any script, so their own surfaces can group and filter their rooms. Compared exactly, as a string: a key holder does not case-fold or normalise it.\",\n \"maxLength\": 32,\n \"minLength\": 1,\n \"pattern\": \"^[^\\\\u0000-\\\\u001F\\\\u007F]+$\",\n \"title\": \"PersonalLabelTag\",\n \"type\": \"string\"\n },\n \"PersonalLabelTags\": {\n \"description\": \"The member's tags for the room, one to sixteen, as a set: order carries no meaning. A room with no tags has no `tags` member, never an empty list, so there is one way to say \\\"none\\\".\",\n \"items\": {\n \"$ref\": \"#/$defs/PersonalLabelTag\"\n },\n \"maxItems\": 16,\n \"minItems\": 1,\n \"title\": \"PersonalLabelTags\",\n \"type\": \"array\",\n \"uniqueItems\": true\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"Success response to rooms/keys/list. Type https://trusttasks.org/spec/rooms/keys/list/0.2#response. The rooms this key holder can open, one entry per room and member, for the members the caller may act as. This is key custody, not membership: a room whose group state was never delivered is absent here and the member may still hold a perfectly good VMC for it.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"rooms\": {\n \"description\": \"One entry per room and member, in no guaranteed order. A room held as two members the caller may act as appears twice, once per member.\",\n \"items\": {\n \"additionalProperties\": false,\n \"properties\": {\n \"earliestReadableEpoch\": {\n \"description\": \"The earliest epoch this key holder can derive a key for, for this member, walking the epoch key chain it holds. Equal to `epoch` means it reads only from where it joined; `1` means the room's whole retained history. Anything between is a chain that has been delivered in part, or one deliberately severed below that point.\",\n \"minimum\": 1,\n \"type\": \"integer\"\n },\n \"epoch\": {\n \"description\": \"The epoch this key holder is at for this member. Behind the room's own epoch means a commit has not been delivered, and records sealed since will not open.\",\n \"minimum\": 1,\n \"type\": \"integer\"\n },\n \"member\": {\n \"description\": \"The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.\",\n \"maxLength\": 2048,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"personal\": {\n \"$ref\": \"#/$defs/PersonalLabel\",\n \"description\": \"The member's own label for the room (rooms/keys/label). Present only when the request set `includePersonal: true` and the member has one. Private to the member: a caller MUST NOT pass it to the room's host, its owner, a community or a website the member has not chosen to show it to.\"\n },\n \"roomId\": {\n \"description\": \"The room's identifier.\",\n \"maxLength\": 512,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"roomId\",\n \"member\",\n \"epoch\",\n \"earliestReadableEpoch\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"rooms\"\n ],\n \"title\": \"Rooms Keys List — response payload\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/rooms/keys/list/0.2\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"description\": \"List the rooms the key holder can open for members the caller may act as. `includePersonal` asks for each entry's personal label as well; absent, none is returned. Carries no filter: the recipient answers for the members its caller acts as, and there is nothing to ask it about. The outer document members are owned by the framework — SPEC §6.3.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\",\n \"description\": \"Ecosystem-defined extension members per SPEC.md §4.5.1.\"\n },\n \"includePersonal\": {\n \"description\": \"`true` asks for each entry's personal label (rooms/keys/label) in `personal`. Absent or `false`: no entry carries one. A request option, not a filter — it changes which members of an entry are returned, never which entries — and off by default so that a caller that has no use for the member's own names, or will pass the list on, never receives them.\",\n \"type\": \"boolean\"\n }\n },\n \"title\": \"Rooms Keys List — payload\",\n \"type\": \"object\"\n}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/rooms/keys/list/0.2#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(
"{\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 \"PersonalLabel\": {\n \"additionalProperties\": false,\n \"description\": \"A member's personal label for one room, as their key holder keeps it: at least one detail (`minProperties` counts `updatedAt`), and when it last changed. A key holder that holds no detail for the room holds no label, and returns none — there is no empty label.\",\n \"minProperties\": 2,\n \"properties\": {\n \"description\": {\n \"$ref\": \"#/$defs/PersonalLabelDescription\"\n },\n \"label\": {\n \"$ref\": \"#/$defs/PersonalLabelName\"\n },\n \"notes\": {\n \"$ref\": \"#/$defs/PersonalLabelNotes\"\n },\n \"tags\": {\n \"$ref\": \"#/$defs/PersonalLabelTags\"\n },\n \"updatedAt\": {\n \"description\": \"When the label last changed, as the key holder recorded it. A request that changed nothing does not move it.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"updatedAt\"\n ],\n \"title\": \"PersonalLabel\",\n \"type\": \"object\"\n },\n \"PersonalLabelDescription\": {\n \"description\": \"What the room is to the member, in a sentence or a short paragraph. Line breaks and tabs are allowed; other control characters are not.\",\n \"maxLength\": 1000,\n \"minLength\": 1,\n \"pattern\": \"^[^\\\\u0000-\\\\u0008\\\\u000B\\\\u000C\\\\u000E-\\\\u001F\\\\u007F]+$\",\n \"title\": \"PersonalLabelDescription\",\n \"type\": \"string\"\n },\n \"PersonalLabelName\": {\n \"description\": \"The member's own name for the room, on one line: no control characters, line breaks included. Shown before every name a third party gave the room, because it is the only one nobody else wrote.\",\n \"maxLength\": 128,\n \"minLength\": 1,\n \"pattern\": \"^[^\\\\u0000-\\\\u001F\\\\u007F]+$\",\n \"title\": \"PersonalLabelName\",\n \"type\": \"string\"\n },\n \"PersonalLabelNotes\": {\n \"description\": \"Longer free-form notes the member keeps about the room: who introduced them, what to look for in it, what they agreed there. Line breaks and tabs are allowed; other control characters are not.\",\n \"maxLength\": 4000,\n \"minLength\": 1,\n \"pattern\": \"^[^\\\\u0000-\\\\u0008\\\\u000B\\\\u000C\\\\u000E-\\\\u001F\\\\u007F]+$\",\n \"title\": \"PersonalLabelNotes\",\n \"type\": \"string\"\n },\n \"PersonalLabelTag\": {\n \"description\": \"A word or short phrase the member files the room under, in any script, so their own surfaces can group and filter their rooms. Compared exactly, as a string: a key holder does not case-fold or normalise it.\",\n \"maxLength\": 32,\n \"minLength\": 1,\n \"pattern\": \"^[^\\\\u0000-\\\\u001F\\\\u007F]+$\",\n \"title\": \"PersonalLabelTag\",\n \"type\": \"string\"\n },\n \"PersonalLabelTags\": {\n \"description\": \"The member's tags for the room, one to sixteen, as a set: order carries no meaning. A room with no tags has no `tags` member, never an empty list, so there is one way to say \\\"none\\\".\",\n \"items\": {\n \"$ref\": \"#/$defs/PersonalLabelTag\"\n },\n \"maxItems\": 16,\n \"minItems\": 1,\n \"title\": \"PersonalLabelTags\",\n \"type\": \"array\",\n \"uniqueItems\": true\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"Success response to rooms/keys/list. Type https://trusttasks.org/spec/rooms/keys/list/0.2#response. The rooms this key holder can open, one entry per room and member, for the members the caller may act as. This is key custody, not membership: a room whose group state was never delivered is absent here and the member may still hold a perfectly good VMC for it.\",\n \"properties\": {\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"rooms\": {\n \"description\": \"One entry per room and member, in no guaranteed order. A room held as two members the caller may act as appears twice, once per member.\",\n \"items\": {\n \"additionalProperties\": false,\n \"properties\": {\n \"earliestReadableEpoch\": {\n \"description\": \"The earliest epoch this key holder can derive a key for, for this member, walking the epoch key chain it holds. Equal to `epoch` means it reads only from where it joined; `1` means the room's whole retained history. Anything between is a chain that has been delivered in part, or one deliberately severed below that point.\",\n \"minimum\": 1,\n \"type\": \"integer\"\n },\n \"epoch\": {\n \"description\": \"The epoch this key holder is at for this member. Behind the room's own epoch means a commit has not been delivered, and records sealed since will not open.\",\n \"minimum\": 1,\n \"type\": \"integer\"\n },\n \"member\": {\n \"description\": \"The member this entry's group state is held for: the DID the room admitted. What a client names as `member` to rooms/keys/label, and as `issuer` to rooms/keys/act, to act on this entry rather than on the same room held as another member.\",\n \"maxLength\": 2048,\n \"pattern\": \"^did:\",\n \"type\": \"string\"\n },\n \"personal\": {\n \"$ref\": \"#/$defs/PersonalLabel\",\n \"description\": \"The member's own label for the room (rooms/keys/label). Present only when the request set `includePersonal: true` and the member has one. Private to the member: a caller MUST NOT pass it to the room's host, its owner, a community or a website the member has not chosen to show it to.\"\n },\n \"roomId\": {\n \"description\": \"The room's identifier.\",\n \"maxLength\": 512,\n \"minLength\": 1,\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"roomId\",\n \"member\",\n \"epoch\",\n \"earliestReadableEpoch\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n }\n },\n \"required\": [\n \"rooms\"\n ],\n \"title\": \"Rooms Keys List — response payload\",\n \"type\": \"object\"\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] = &[];