//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `vta/app-state/get-many`. Version: `1.0`.
/// Why this specification version is deprecated (SPEC "Superseded and
/// Withdrawn Versions"), or `None` while it is current.
pub const DEPRECATION: Option<&str> = None;
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
/// Error types.
pub mod error {
/// Error from a `TryFrom` or `FromStr` implementation.
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
///A record as the maintainer holds it. `value` is absent in three distinct situations and a consumer MUST NOT conflate them: the record is a tombstone (`deleted` is true); the caller asked for a metadata-only view (`list` without `includeValues`); or the value genuinely is the JSON literal `null`, in which case `value` is PRESENT and null. This is why `deleted` is required rather than defaulted — a consumer that has to infer deletion from an absent value gets the tombstone case wrong exactly when convergence depends on it.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct AppStateRecord {
///The VTA context the record is scoped to; the isolation boundary.
#[serde(rename = "contextId")]
pub context_id: AppStateRecordContextId,
///When the record was first created at this address. MAY be absent on a tombstone whose body has been discarded.
#[serde(
rename = "createdAt",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub created_at: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
///True when this is a tombstone: the record was deleted, and this entry exists so that a consumer syncing incrementally learns of the deletion. Tombstones are reaped after the maintainer's retention window; see `vta/app-state/list`.
pub deleted: bool,
///When the record was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.
#[serde(
rename = "deletedAt",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub deleted_at: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
pub key: Key,
pub namespace: Namespace,
///When the write that produced this `version` was applied. For a tombstone, when the delete was applied.
#[serde(rename = "updatedAt")]
pub updated_at: ::chrono::DateTime<::chrono::offset::Utc>,
///The stored JSON, in whatever shape the owning application chose. Any JSON value, including `null`. The maintainer neither validates nor interprets it. Absent when this is a tombstone or a metadata-only view — see this definition's description for why that is not the same as a null value.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub value: ::std::option::Option<::serde_json::Value>,
///Size of the stored value in bytes, measured as the maintainer measures it for the per-record cap (see `vta/app-state/put`). Present in metadata-only views so a consumer can decide what to fetch without fetching it; absent on a tombstone.
#[serde(
rename = "valueBytes",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub value_bytes: ::std::option::Option<u64>,
///The namespace counter value this record's most recent write took. Supply it as `expectedVersion` on the next write to make that write conditional on nothing having changed in between.
pub version: Version,
}
impl AppStateRecord {
pub fn builder() -> builder::AppStateRecord {
Default::default()
}
}
///The VTA context the record is scoped to; the isolation boundary.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct AppStateRecordContextId(::std::string::String);
impl ::std::ops::Deref for AppStateRecordContextId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<AppStateRecordContextId> for ::std::string::String {
fn from(value: AppStateRecordContextId) -> Self {
value.0
}
}
impl ::std::str::FromStr for AppStateRecordContextId {
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 AppStateRecordContextId {
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 AppStateRecordContextId {
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 AppStateRecordContextId {
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 AppStateRecordContextId {
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())
})
}
}
///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())
})
}
}
///Application-chosen identifier for a record within a namespace. Opaque to the maintainer: it MUST NOT be parsed, normalized, or case-folded, and prefix matching in `list` is a byte-prefix comparison over the UTF-8 encoding. Applications SHOULD use `/`-delimited hierarchical keys (`community/acme`, `contact/z6Mk…`) so that `prefix` can address a record family, but the delimiter is a convention between an application and itself — the maintainer attaches no meaning to it.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct Key(::std::string::String);
impl ::std::ops::Deref for Key {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<Key> for ::std::string::String {
fn from(value: Key) -> Self {
value.0
}
}
impl ::std::str::FromStr for Key {
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());
}
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| ::regress::Regex::new("^[^\\u0000]+$").unwrap());
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[^\\u0000]+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for Key {
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 Key {
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 Key {
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 Key {
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())
})
}
}
///Scopes one application's records within a context, so several tools can share a context without colliding — `openvtc`, `cnm`, an agent runtime. The maintainer MUST NOT interpret the value; it is an opaque partition name. Namespaces are first-come and unreserved, so an application SHOULD pick a stable, specific one: a future per-namespace ACL would grant on this exact string, which makes renaming a namespace a migration rather than an edit.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct Namespace(::std::string::String);
impl ::std::ops::Deref for Namespace {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<Namespace> for ::std::string::String {
fn from(value: Namespace) -> Self {
value.0
}
}
impl ::std::str::FromStr for Namespace {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() > 64usize {
return Err("longer than 64 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-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 Namespace {
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 Namespace {
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 Namespace {
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 Namespace {
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())
})
}
}
///Read up to 256 application-state records from one namespace in a single round trip. A rebuild or a reconnect is N records, and round-tripping each one separately is the difference between a usable reconnect and an unusable one.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Payload {
///The VTA context the records are scoped to; the isolation boundary.
#[serde(rename = "contextId")]
pub context_id: PayloadContextId,
///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>,
///Defaults to false. When true, an address holding a tombstone yields a record with `deleted: true` rather than appearing in `missing`.
#[serde(
rename = "includeDeleted",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub include_deleted: ::std::option::Option<bool>,
///The keys to read. Duplicates are refused rather than deduplicated, because a caller that sent one did not mean to and would otherwise never find out.
pub keys: Vec<Key>,
///Required, unlike in list: a batch read addresses records by key, and a key is only unique within a namespace.
pub namespace: Namespace,
}
impl Payload {
pub fn builder() -> builder::Payload {
Default::default()
}
}
///The VTA context the records are scoped to; the isolation boundary.
///
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadContextId(::std::string::String);
impl ::std::ops::Deref for PayloadContextId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadContextId> for ::std::string::String {
fn from(value: PayloadContextId) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadContextId {
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 PayloadContextId {
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 PayloadContextId {
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 PayloadContextId {
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 PayloadContextId {
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())
})
}
}
///Success response to vta/app-state/get-many. Type https://trusttasks.org/spec/vta/app-state/get-many/1.0#response. Every requested key appears in exactly one of `records`, `missing` or `deferred`, so a caller can account for all of them without comparing sets itself.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
#[non_exhaustive]
pub struct Response {
///Requested keys the maintainer did not evaluate because the response had reached its size budget. The caller re-requests exactly these. This exists because the per-record cap multiplied by the key ceiling exceeds any sane response limit, and the alternative — refusing the whole batch — would make a caller guess at a batch size instead of being told one.
#[serde(default, skip_serializing_if = "::std::vec::Vec::is_empty")]
pub deferred: ::std::vec::Vec<Key>,
///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>,
///Requested keys holding no record — and, unless `includeDeleted` was set, keys holding only a tombstone. Reported rather than silently omitted, so a caller need not diff the request against the response to notice.
pub missing: ::std::vec::Vec<Key>,
///The records found, each with its `value`, in the order the keys were requested. May be empty.
pub records: ::std::vec::Vec<AppStateRecord>,
}
impl Response {
pub fn builder() -> builder::Response {
Default::default()
}
}
///A value of the namespace's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.
///
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct Version(pub ::std::num::NonZeroU64);
impl ::std::ops::Deref for Version {
type Target = ::std::num::NonZeroU64;
fn deref(&self) -> &::std::num::NonZeroU64 {
&self.0
}
}
impl ::std::convert::From<Version> for ::std::num::NonZeroU64 {
fn from(value: Version) -> Self {
value.0
}
}
impl ::std::convert::From<::std::num::NonZeroU64> for Version {
fn from(value: ::std::num::NonZeroU64) -> Self {
Self(value)
}
}
impl ::std::str::FromStr for Version {
type Err = <::std::num::NonZeroU64 as ::std::str::FromStr>::Err;
fn from_str(value: &str) -> ::std::result::Result<Self, Self::Err> {
Ok(Self(value.parse()?))
}
}
impl ::std::convert::TryFrom<&str> for Version {
type Error = <::std::num::NonZeroU64 as ::std::str::FromStr>::Err;
fn try_from(value: &str) -> ::std::result::Result<Self, Self::Error> {
value.parse()
}
}
impl ::std::convert::TryFrom<String> for Version {
type Error = <::std::num::NonZeroU64 as ::std::str::FromStr>::Err;
fn try_from(value: String) -> ::std::result::Result<Self, Self::Error> {
value.parse()
}
}
impl ::std::fmt::Display for Version {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
self.0.fmt(f)
}
}
/// Types for composing complex structures.
pub mod builder {
#[derive(Clone, Debug)]
pub struct AppStateRecord {
context_id: ::std::result::Result<super::AppStateRecordContextId, ::std::string::String>,
created_at: ::std::result::Result<
::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
::std::string::String,
>,
deleted: ::std::result::Result<bool, ::std::string::String>,
deleted_at: ::std::result::Result<
::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
::std::string::String,
>,
key: ::std::result::Result<super::Key, ::std::string::String>,
namespace: ::std::result::Result<super::Namespace, ::std::string::String>,
updated_at:
::std::result::Result<::chrono::DateTime<::chrono::offset::Utc>, ::std::string::String>,
value: ::std::result::Result<
::std::option::Option<::serde_json::Value>,
::std::string::String,
>,
value_bytes: ::std::result::Result<::std::option::Option<u64>, ::std::string::String>,
version: ::std::result::Result<super::Version, ::std::string::String>,
}
impl ::std::default::Default for AppStateRecord {
fn default() -> Self {
Self {
context_id: Err("no value supplied for context_id".to_string()),
created_at: Ok(Default::default()),
deleted: Err("no value supplied for deleted".to_string()),
deleted_at: Ok(Default::default()),
key: Err("no value supplied for key".to_string()),
namespace: Err("no value supplied for namespace".to_string()),
updated_at: Err("no value supplied for updated_at".to_string()),
value: Ok(Default::default()),
value_bytes: Ok(Default::default()),
version: Err("no value supplied for version".to_string()),
}
}
}
impl AppStateRecord {
pub fn context_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::AppStateRecordContextId>,
T::Error: ::std::fmt::Display,
{
self.context_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for context_id: {e}"));
self
}
pub fn created_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<
::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
>,
T::Error: ::std::fmt::Display,
{
self.created_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for created_at: {e}"));
self
}
pub fn deleted<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<bool>,
T::Error: ::std::fmt::Display,
{
self.deleted = value
.try_into()
.map_err(|e| format!("error converting supplied value for deleted: {e}"));
self
}
pub fn deleted_at<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<
::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
>,
T::Error: ::std::fmt::Display,
{
self.deleted_at = value
.try_into()
.map_err(|e| format!("error converting supplied value for deleted_at: {e}"));
self
}
pub fn key<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Key>,
T::Error: ::std::fmt::Display,
{
self.key = value
.try_into()
.map_err(|e| format!("error converting supplied value for key: {e}"));
self
}
pub fn namespace<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Namespace>,
T::Error: ::std::fmt::Display,
{
self.namespace = value
.try_into()
.map_err(|e| format!("error converting supplied value for namespace: {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
}
pub fn value<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<::serde_json::Value>>,
T::Error: ::std::fmt::Display,
{
self.value = value
.try_into()
.map_err(|e| format!("error converting supplied value for value: {e}"));
self
}
pub fn value_bytes<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<u64>>,
T::Error: ::std::fmt::Display,
{
self.value_bytes = value
.try_into()
.map_err(|e| format!("error converting supplied value for value_bytes: {e}"));
self
}
pub fn version<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Version>,
T::Error: ::std::fmt::Display,
{
self.version = value
.try_into()
.map_err(|e| format!("error converting supplied value for version: {e}"));
self
}
}
impl ::std::convert::TryFrom<AppStateRecord> for super::AppStateRecord {
type Error = super::error::ConversionError;
fn try_from(
value: AppStateRecord,
) -> ::std::result::Result<Self, super::error::ConversionError> {
Ok(Self {
context_id: value.context_id?,
created_at: value.created_at?,
deleted: value.deleted?,
deleted_at: value.deleted_at?,
key: value.key?,
namespace: value.namespace?,
updated_at: value.updated_at?,
value: value.value?,
value_bytes: value.value_bytes?,
version: value.version?,
})
}
}
impl ::std::convert::From<super::AppStateRecord> for AppStateRecord {
fn from(value: super::AppStateRecord) -> Self {
Self {
context_id: Ok(value.context_id),
created_at: Ok(value.created_at),
deleted: Ok(value.deleted),
deleted_at: Ok(value.deleted_at),
key: Ok(value.key),
namespace: Ok(value.namespace),
updated_at: Ok(value.updated_at),
value: Ok(value.value),
value_bytes: Ok(value.value_bytes),
version: Ok(value.version),
}
}
}
#[derive(Clone, Debug)]
pub struct Payload {
context_id: ::std::result::Result<super::PayloadContextId, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
include_deleted: ::std::result::Result<::std::option::Option<bool>, ::std::string::String>,
keys: ::std::result::Result<Vec<super::Key>, ::std::string::String>,
namespace: ::std::result::Result<super::Namespace, ::std::string::String>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
context_id: Err("no value supplied for context_id".to_string()),
ext: Ok(Default::default()),
include_deleted: Ok(Default::default()),
keys: Err("no value supplied for keys".to_string()),
namespace: Err("no value supplied for namespace".to_string()),
}
}
}
impl Payload {
pub fn context_id<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::PayloadContextId>,
T::Error: ::std::fmt::Display,
{
self.context_id = value
.try_into()
.map_err(|e| format!("error converting supplied value for context_id: {e}"));
self
}
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn include_deleted<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<bool>>,
T::Error: ::std::fmt::Display,
{
self.include_deleted = value
.try_into()
.map_err(|e| format!("error converting supplied value for include_deleted: {e}"));
self
}
pub fn keys<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<Vec<super::Key>>,
T::Error: ::std::fmt::Display,
{
self.keys = value
.try_into()
.map_err(|e| format!("error converting supplied value for keys: {e}"));
self
}
pub fn namespace<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<super::Namespace>,
T::Error: ::std::fmt::Display,
{
self.namespace = value
.try_into()
.map_err(|e| format!("error converting supplied value for namespace: {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 {
context_id: value.context_id?,
ext: value.ext?,
include_deleted: value.include_deleted?,
keys: value.keys?,
namespace: value.namespace?,
})
}
}
impl ::std::convert::From<super::Payload> for Payload {
fn from(value: super::Payload) -> Self {
Self {
context_id: Ok(value.context_id),
ext: Ok(value.ext),
include_deleted: Ok(value.include_deleted),
keys: Ok(value.keys),
namespace: Ok(value.namespace),
}
}
}
#[derive(Clone, Debug)]
pub struct Response {
deferred: ::std::result::Result<::std::vec::Vec<super::Key>, ::std::string::String>,
ext: ::std::result::Result<::std::option::Option<super::Ext>, ::std::string::String>,
missing: ::std::result::Result<::std::vec::Vec<super::Key>, ::std::string::String>,
records:
::std::result::Result<::std::vec::Vec<super::AppStateRecord>, ::std::string::String>,
}
impl ::std::default::Default for Response {
fn default() -> Self {
Self {
deferred: Ok(Default::default()),
ext: Ok(Default::default()),
missing: Err("no value supplied for missing".to_string()),
records: Err("no value supplied for records".to_string()),
}
}
}
impl Response {
pub fn deferred<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::vec::Vec<super::Key>>,
T::Error: ::std::fmt::Display,
{
self.deferred = value
.try_into()
.map_err(|e| format!("error converting supplied value for deferred: {e}"));
self
}
pub fn ext<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::option::Option<super::Ext>>,
T::Error: ::std::fmt::Display,
{
self.ext = value
.try_into()
.map_err(|e| format!("error converting supplied value for ext: {e}"));
self
}
pub fn missing<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::vec::Vec<super::Key>>,
T::Error: ::std::fmt::Display,
{
self.missing = value
.try_into()
.map_err(|e| format!("error converting supplied value for missing: {e}"));
self
}
pub fn records<T>(mut self, value: T) -> Self
where
T: ::std::convert::TryInto<::std::vec::Vec<super::AppStateRecord>>,
T::Error: ::std::fmt::Display,
{
self.records = value
.try_into()
.map_err(|e| format!("error converting supplied value for records: {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 {
deferred: value.deferred?,
ext: value.ext?,
missing: value.missing?,
records: value.records?,
})
}
}
impl ::std::convert::From<super::Response> for Response {
fn from(value: super::Response) -> Self {
Self {
deferred: Ok(value.deferred),
ext: Ok(value.ext),
missing: Ok(value.missing),
records: Ok(value.records),
}
}
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/vta/app-state/get-many/1.0";
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\"$defs\":{\"AppStateRecord\":{\"additionalProperties\":false,\"description\":\"A record as the maintainer holds it. `value` is absent in three distinct situations and a consumer MUST NOT conflate them: the record is a tombstone (`deleted` is true); the caller asked for a metadata-only view (`list` without `includeValues`); or the value genuinely is the JSON literal `null`, in which case `value` is PRESENT and null. This is why `deleted` is required rather than defaulted — a consumer that has to infer deletion from an absent value gets the tombstone case wrong exactly when convergence depends on it.\",\"properties\":{\"contextId\":{\"description\":\"The VTA context the record is scoped to; the isolation boundary.\",\"minLength\":1,\"type\":\"string\"},\"createdAt\":{\"description\":\"When the record was first created at this address. MAY be absent on a tombstone whose body has been discarded.\",\"format\":\"date-time\",\"type\":\"string\"},\"deleted\":{\"description\":\"True when this is a tombstone: the record was deleted, and this entry exists so that a consumer syncing incrementally learns of the deletion. Tombstones are reaped after the maintainer's retention window; see `vta/app-state/list`.\",\"type\":\"boolean\"},\"deletedAt\":{\"description\":\"When the record was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.\",\"format\":\"date-time\",\"type\":\"string\"},\"key\":{\"$ref\":\"#/$defs/Key\"},\"namespace\":{\"$ref\":\"#/$defs/Namespace\"},\"updatedAt\":{\"description\":\"When the write that produced this `version` was applied. For a tombstone, when the delete was applied.\",\"format\":\"date-time\",\"type\":\"string\"},\"value\":{\"description\":\"The stored JSON, in whatever shape the owning application chose. Any JSON value, including `null`. The maintainer neither validates nor interprets it. Absent when this is a tombstone or a metadata-only view — see this definition's description for why that is not the same as a null value.\"},\"valueBytes\":{\"description\":\"Size of the stored value in bytes, measured as the maintainer measures it for the per-record cap (see `vta/app-state/put`). Present in metadata-only views so a consumer can decide what to fetch without fetching it; absent on a tombstone.\",\"minimum\":0,\"type\":\"integer\"},\"version\":{\"$ref\":\"#/$defs/Version\",\"description\":\"The namespace counter value this record's most recent write took. Supply it as `expectedVersion` on the next write to make that write conditional on nothing having changed in between.\"}},\"required\":[\"contextId\",\"namespace\",\"key\",\"version\",\"deleted\",\"updatedAt\"],\"title\":\"AppStateRecord\",\"type\":\"object\"},\"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\"},\"Key\":{\"description\":\"Application-chosen identifier for a record within a namespace. Opaque to the maintainer: it MUST NOT be parsed, normalized, or case-folded, and prefix matching in `list` is a byte-prefix comparison over the UTF-8 encoding. Applications SHOULD use `/`-delimited hierarchical keys (`community/acme`, `contact/z6Mk…`) so that `prefix` can address a record family, but the delimiter is a convention between an application and itself — the maintainer attaches no meaning to it.\",\"maxLength\":512,\"minLength\":1,\"pattern\":\"^[^\\\\u0000]+$\",\"title\":\"Key\",\"type\":\"string\"},\"Namespace\":{\"description\":\"Scopes one application's records within a context, so several tools can share a context without colliding — `openvtc`, `cnm`, an agent runtime. The maintainer MUST NOT interpret the value; it is an opaque partition name. Namespaces are first-come and unreserved, so an application SHOULD pick a stable, specific one: a future per-namespace ACL would grant on this exact string, which makes renaming a namespace a migration rather than an edit.\",\"maxLength\":64,\"minLength\":1,\"pattern\":\"^[a-z][a-z0-9]*(-[a-z0-9]+)*$\",\"title\":\"Namespace\",\"type\":\"string\"},\"Response\":{\"$anchor\":\"response\",\"additionalProperties\":false,\"description\":\"Success response to vta/app-state/get-many. Type https://trusttasks.org/spec/vta/app-state/get-many/1.0#response. Every requested key appears in exactly one of `records`, `missing` or `deferred`, so a caller can account for all of them without comparing sets itself.\",\"properties\":{\"deferred\":{\"description\":\"Requested keys the maintainer did not evaluate because the response had reached its size budget. The caller re-requests exactly these. This exists because the per-record cap multiplied by the key ceiling exceeds any sane response limit, and the alternative — refusing the whole batch — would make a caller guess at a batch size instead of being told one.\",\"items\":{\"$ref\":\"#/$defs/Key\"},\"type\":\"array\"},\"ext\":{\"$ref\":\"#/$defs/Ext\",\"description\":\"Ecosystem-defined extension members per SPEC.md §4.5.1.\"},\"missing\":{\"description\":\"Requested keys holding no record — and, unless `includeDeleted` was set, keys holding only a tombstone. Reported rather than silently omitted, so a caller need not diff the request against the response to notice.\",\"items\":{\"$ref\":\"#/$defs/Key\"},\"type\":\"array\"},\"records\":{\"description\":\"The records found, each with its `value`, in the order the keys were requested. May be empty.\",\"items\":{\"$ref\":\"#/$defs/AppStateRecord\"},\"type\":\"array\"}},\"required\":[\"records\",\"missing\"],\"title\":\"VTA Application State Get-Many — response payload\",\"type\":\"object\"},\"Version\":{\"description\":\"A value of the namespace's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.\",\"minimum\":1,\"title\":\"Version\",\"type\":\"integer\"}},\"$id\":\"https://trusttasks.org/spec/vta/app-state/get-many/1.0\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"additionalProperties\":false,\"description\":\"Read up to 256 application-state records from one namespace in a single round trip. A rebuild or a reconnect is N records, and round-tripping each one separately is the difference between a usable reconnect and an unusable one.\",\"properties\":{\"contextId\":{\"description\":\"The VTA context the records are scoped to; the isolation boundary.\",\"minLength\":1,\"type\":\"string\"},\"ext\":{\"$ref\":\"#/$defs/Ext\",\"description\":\"Ecosystem-defined extension members per SPEC.md §4.5.1.\"},\"includeDeleted\":{\"description\":\"Defaults to false. When true, an address holding a tombstone yields a record with `deleted: true` rather than appearing in `missing`.\",\"type\":\"boolean\"},\"keys\":{\"description\":\"The keys to read. Duplicates are refused rather than deduplicated, because a caller that sent one did not mean to and would otherwise never find out.\",\"items\":{\"$ref\":\"#/$defs/Key\"},\"maxItems\":256,\"minItems\":1,\"type\":\"array\",\"uniqueItems\":true},\"namespace\":{\"$ref\":\"#/$defs/Namespace\",\"description\":\"Required, unlike in list: a batch read addresses records by key, and a key is only unique within a namespace.\"}},\"required\":[\"contextId\",\"namespace\",\"keys\"],\"title\":\"VTA Application State Get-Many — payload\",\"type\":\"object\"}\n",
);
}
impl crate::Payload for Response {
const TYPE_URI: &'static str =
"https://trusttasks.org/spec/vta/app-state/get-many/1.0#response";
const IS_RECIPIENT_REQUIRED: bool = true;
const PAYLOAD_SCHEMA: Option<&'static str> = Some(
"{\"$defs\":{\"AppStateRecord\":{\"additionalProperties\":false,\"description\":\"A record as the maintainer holds it. `value` is absent in three distinct situations and a consumer MUST NOT conflate them: the record is a tombstone (`deleted` is true); the caller asked for a metadata-only view (`list` without `includeValues`); or the value genuinely is the JSON literal `null`, in which case `value` is PRESENT and null. This is why `deleted` is required rather than defaulted — a consumer that has to infer deletion from an absent value gets the tombstone case wrong exactly when convergence depends on it.\",\"properties\":{\"contextId\":{\"description\":\"The VTA context the record is scoped to; the isolation boundary.\",\"minLength\":1,\"type\":\"string\"},\"createdAt\":{\"description\":\"When the record was first created at this address. MAY be absent on a tombstone whose body has been discarded.\",\"format\":\"date-time\",\"type\":\"string\"},\"deleted\":{\"description\":\"True when this is a tombstone: the record was deleted, and this entry exists so that a consumer syncing incrementally learns of the deletion. Tombstones are reaped after the maintainer's retention window; see `vta/app-state/list`.\",\"type\":\"boolean\"},\"deletedAt\":{\"description\":\"When the record was deleted. Present only when `deleted` is true; equal to `updatedAt` for a tombstone the maintainer has not since rewritten.\",\"format\":\"date-time\",\"type\":\"string\"},\"key\":{\"$ref\":\"#/$defs/Key\"},\"namespace\":{\"$ref\":\"#/$defs/Namespace\"},\"updatedAt\":{\"description\":\"When the write that produced this `version` was applied. For a tombstone, when the delete was applied.\",\"format\":\"date-time\",\"type\":\"string\"},\"value\":{\"description\":\"The stored JSON, in whatever shape the owning application chose. Any JSON value, including `null`. The maintainer neither validates nor interprets it. Absent when this is a tombstone or a metadata-only view — see this definition's description for why that is not the same as a null value.\"},\"valueBytes\":{\"description\":\"Size of the stored value in bytes, measured as the maintainer measures it for the per-record cap (see `vta/app-state/put`). Present in metadata-only views so a consumer can decide what to fetch without fetching it; absent on a tombstone.\",\"minimum\":0,\"type\":\"integer\"},\"version\":{\"$ref\":\"#/$defs/Version\",\"description\":\"The namespace counter value this record's most recent write took. Supply it as `expectedVersion` on the next write to make that write conditional on nothing having changed in between.\"}},\"required\":[\"contextId\",\"namespace\",\"key\",\"version\",\"deleted\",\"updatedAt\"],\"title\":\"AppStateRecord\",\"type\":\"object\"},\"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\"},\"Key\":{\"description\":\"Application-chosen identifier for a record within a namespace. Opaque to the maintainer: it MUST NOT be parsed, normalized, or case-folded, and prefix matching in `list` is a byte-prefix comparison over the UTF-8 encoding. Applications SHOULD use `/`-delimited hierarchical keys (`community/acme`, `contact/z6Mk…`) so that `prefix` can address a record family, but the delimiter is a convention between an application and itself — the maintainer attaches no meaning to it.\",\"maxLength\":512,\"minLength\":1,\"pattern\":\"^[^\\\\u0000]+$\",\"title\":\"Key\",\"type\":\"string\"},\"Namespace\":{\"description\":\"Scopes one application's records within a context, so several tools can share a context without colliding — `openvtc`, `cnm`, an agent runtime. The maintainer MUST NOT interpret the value; it is an opaque partition name. Namespaces are first-come and unreserved, so an application SHOULD pick a stable, specific one: a future per-namespace ACL would grant on this exact string, which makes renaming a namespace a migration rather than an edit.\",\"maxLength\":64,\"minLength\":1,\"pattern\":\"^[a-z][a-z0-9]*(-[a-z0-9]+)*$\",\"title\":\"Namespace\",\"type\":\"string\"},\"Response\":{\"$anchor\":\"response\",\"additionalProperties\":false,\"description\":\"Success response to vta/app-state/get-many. Type https://trusttasks.org/spec/vta/app-state/get-many/1.0#response. Every requested key appears in exactly one of `records`, `missing` or `deferred`, so a caller can account for all of them without comparing sets itself.\",\"properties\":{\"deferred\":{\"description\":\"Requested keys the maintainer did not evaluate because the response had reached its size budget. The caller re-requests exactly these. This exists because the per-record cap multiplied by the key ceiling exceeds any sane response limit, and the alternative — refusing the whole batch — would make a caller guess at a batch size instead of being told one.\",\"items\":{\"$ref\":\"#/$defs/Key\"},\"type\":\"array\"},\"ext\":{\"$ref\":\"#/$defs/Ext\",\"description\":\"Ecosystem-defined extension members per SPEC.md §4.5.1.\"},\"missing\":{\"description\":\"Requested keys holding no record — and, unless `includeDeleted` was set, keys holding only a tombstone. Reported rather than silently omitted, so a caller need not diff the request against the response to notice.\",\"items\":{\"$ref\":\"#/$defs/Key\"},\"type\":\"array\"},\"records\":{\"description\":\"The records found, each with its `value`, in the order the keys were requested. May be empty.\",\"items\":{\"$ref\":\"#/$defs/AppStateRecord\"},\"type\":\"array\"}},\"required\":[\"records\",\"missing\"],\"title\":\"VTA Application State Get-Many — response payload\",\"type\":\"object\"},\"Version\":{\"description\":\"A value of the namespace's monotonic write counter (see this schema's description). Server-assigned; a producer never chooses one.\",\"minimum\":1,\"title\":\"Version\",\"type\":\"integer\"}},\"$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::CONTEXT_NOT_FOUND, error_codes::DUPLICATE_KEY];
/// One constant per extended error code this specification declares
/// (SPEC §7.3 item 9), named for its local part.
///
/// Emit these rather than a string literal: the code is read from the
/// specification, so it cannot name a code the specification never
/// declared.
pub mod error_codes {
/// `vta/app-state:contextNotFound`
///
/// OPTIONAL diagnostic, for a maintainer whose authorization model can tell "no such context" from "not permitted to reach it". Where it cannot — an ACL that enumerates the contexts a caller may act in answers both the same way — the framework's standard `permissionDenied` (SPEC §8.3) is the conforming answer to both, and this code is never emitted. Refusing an unauthorized caller is NOT this code.
///
/// Declared `retryable: false`.
pub const CONTEXT_NOT_FOUND: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vta/app-state:contextNotFound",
retryable: false,
details_schema: ::core::option::Option::None,
};
/// `vta/app-state/get-many:duplicateKey`
///
/// The `keys` array contains the same key more than once. Refused rather than deduplicated, because a caller that sent a duplicate did not mean to.
///
/// Declared `retryable: false`.
/// Declares a `detailsSchema` for the error's `details` member.
pub const DUPLICATE_KEY: crate::DeclaredErrorCode = crate::DeclaredErrorCode {
code: "vta/app-state/get-many:duplicateKey",
retryable: false,
details_schema: ::core::option::Option::Some(
"{\"additionalProperties\":false,\"properties\":{\"keys\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"type\":\"object\"}",
),
};
}