Response
The server sends exactly one response, whose payload is exactly the byte 0 when the volume has the size stated, exactly the byte 1 when the server has insufficient capacity for it, exactly the byte 2 when the content of the volume exceeds it, or the byte 3 followed by an error as one JSON value, and the response finish follows it.
The server sends exactly one response on the scope. The response finish follows the response, and no frame follows the finish.
[0]
[1]
[2]
[3][error JSON …]- The sequence. Exactly one response precedes the response finish, and nothing follows the finish. A response finish that no response precedes states that the request was not served, as Endpoints provides; the size of the volume is then not stated, and the client learns it from a volumes::list or a volumes::stat request.
- Edited. A payload whose first byte is
0states that the volume has the size stated in the request. The server sends it after the volume has that size, and avolumes::listor avolumes::statrequest the client makes after receiving it reports that size asbytes. The server sends nothing after the byte0, and a client ignores every byte that follows it. - Insufficient capacity. A payload whose first byte is
1states that the server cannot reserve the size stated and did not change the size. The volume has the size it had before the request. The server sends nothing after the byte1, and a client ignores every byte that follows it. - Content too large. A payload whose first byte is
2states that the content of the volume exceeds the size stated, so the volume cannot be shrunk to it, and that the size was not changed. The volume has the size it had before the request, and its content is as it was. The server sends nothing after the byte2, and a client ignores every byte that follows it. - The error. A payload whose first byte is
3carries an error after that byte, running to the end of the payload. The error is exactly one JSON value, in the form defined on the volumes::list response page. This revision prescribes nothing about its content. The error states that the volume has the size it had before the request, and that the reason is neither capacity nor content. - Malformed. A payload with no byte, a payload whose first byte
is none of
0,1,2and3, and a payload whose bytes after3are not one JSON value are malformed.
The response is defined by diverge-provider-sdk/src/endpoints/volumes/edit/server/response/frame.rs:
//! What a server's response frame carries for a volume edit.
use std::fmt;
use crate::decode::Decode;
use crate::encode::{Encode, Writer};
use crate::shared::error::Error;
/// The volume reserves what was asked for, or one of two reasons it
/// does not, or it does not for some other reason.
///
/// One of these on channel `0`, then the scope finishes. A payload
/// leads with one byte saying which — `0` for [`Edited`](Self::Edited),
/// `1` for [`InsufficientCapacity`](Self::InsufficientCapacity), `2`
/// for [`ContentTooLarge`](Self::ContentTooLarge), `3` for
/// [`Error`](Self::Error) — and for the first three there is nothing
/// after it, because saying so IS the whole message.
///
/// | the scope ends with | means |
/// |----------------------|-------|
/// | [`Edited`](Self::Edited), then a finish | a listing will report the new size |
/// | [`InsufficientCapacity`](Self::InsufficientCapacity), then a finish | the provider cannot reserve that many bytes; a listing will report the old size |
/// | [`ContentTooLarge`](Self::ContentTooLarge), then a finish | the volume holds more than that; a listing will report the old size |
/// | an [`Error`](Self::Error), then a finish | a listing will report the old one, for some other reason |
///
/// # Two refusals are answers, not errors
///
/// A provider that cannot reserve the size asked for says so with
/// [`InsufficientCapacity`](Self::InsufficientCapacity), and one asked
/// to shrink a volume below what it holds says so with
/// [`ContentTooLarge`](Self::ContentTooLarge) — never with an
/// [`Error`](Self::Error) a caller could not tell from any other
/// failure. The distinction is what a caller acts on: the first is a
/// size to ask smaller, the second a volume to empty first, and a
/// failure is neither. In both nothing changes.
#[derive(Debug, Clone, PartialEq)]
pub enum Frame {
/// The size is what was asked for. Tag `0`.
Edited,
/// The provider cannot reserve that many bytes, and the size is as
/// it was. Tag `1`.
InsufficientCapacity,
/// The volume holds more than the size asked for, so it cannot be
/// shrunk to it, and the size is as it was. Tag `2`.
ContentTooLarge,
/// A failure. Tag `3`.
///
/// See [`shared::error::Error`](crate::shared::error::Error) for
/// why it says so little.
Error(Error),
}
/// Tag for [`Frame::Edited`].
const EDITED: u8 = 0;
/// Tag for [`Frame::InsufficientCapacity`].
const INSUFFICIENT_CAPACITY: u8 = 1;
/// Tag for [`Frame::ContentTooLarge`].
const CONTENT_TOO_LARGE: u8 = 2;
/// Tag for [`Frame::Error`].
const ERROR: u8 = 3;
/// A tag, and for a failure the JSON after it. Postcard encodes the
/// rest of [`volumes`](crate::endpoints::volumes) and encodes nothing
/// here — an [`Error`](Frame::Error) is a
/// [`serde_json::Value`], which deserializes through
/// `deserialize_any` and so cannot come back out of a format with no
/// self-description. The tag chooses the format, one variant at a
/// time.
impl Encode for Frame {
/// The ordinary JSON failure, from the one variant that has one.
/// A lone tag byte cannot fail.
type Error = serde_json::Error;
// Spelled out rather than `Self::Error`: this enum has a variant
// called `Error`, so the associated type is ambiguous by that name.
fn encode(
&self,
out: &mut Writer<'_>,
) -> Result<(), serde_json::Error> {
match self {
Frame::Edited => {
out.extend_from_slice(&[EDITED]);
Ok(())
}
Frame::InsufficientCapacity => {
out.extend_from_slice(&[INSUFFICIENT_CAPACITY]);
Ok(())
}
Frame::ContentTooLarge => {
out.extend_from_slice(&[CONTENT_TOO_LARGE]);
Ok(())
}
Frame::Error(error) => {
out.extend_from_slice(&[ERROR]);
error.encode(out)
}
}
}
}
impl Decode<'_> for Frame {
/// Three ways to fail, and only one of them is a parse.
type Error = FrameError;
// Spelled out for the same reason as `encode` above.
fn decode(bytes: &[u8]) -> Result<Self, FrameError> {
let (tag, rest) = bytes.split_first().ok_or(FrameError::Empty)?;
match *tag {
EDITED => Ok(Frame::Edited),
INSUFFICIENT_CAPACITY => Ok(Frame::InsufficientCapacity),
CONTENT_TOO_LARGE => Ok(Frame::ContentTooLarge),
ERROR => {
Error::decode(rest).map(Frame::Error).map_err(FrameError::Error)
}
tag => Err(FrameError::UnknownTag(tag)),
}
}
}
/// A volume edit result that could not be read.
#[derive(Debug)]
pub enum FrameError {
/// No bytes at all, so not even a tag.
Empty,
/// A tag that is none of this frame's four.
UnknownTag(u8),
/// The error did not parse.
Error(serde_json::Error),
}
impl fmt::Display for FrameError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
FrameError::Empty => {
f.write_str("volume edit result frame is empty")
}
FrameError::UnknownTag(tag) => {
write!(f, "unknown volume edit result frame tag {tag}")
}
FrameError::Error(error) => {
write!(f, "volume edit error did not parse: {error}")
}
}
}
}
impl std::error::Error for FrameError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
FrameError::Error(error) => Some(error),
FrameError::Empty | FrameError::UnknownTag(_) => None,
}
}
}