Skip to main content

BlobUploadResponse

Struct BlobUploadResponse 

Source
#[non_exhaustive]
pub struct BlobUploadResponse { pub account_id: Id, pub blob_id: Id, pub content_type: String, pub size: u64, pub sha256: Option<Sha256>, pub extra: Map<String, Value>, }
Expand description

Response body returned by a successful blob upload (RFC 8620 §6.1).

§SemVer coupling with jmap-cid-types (bd:JMAP-6r7c.30)

The sha256 field uses jmap_cid_types::Sha256 — a workspace-sibling type, not a wrapped opaque type the way reqwest::Error is wrapped behind HttpError. Consumers that touch BlobUploadResponse.sha256 transitively depend on jmap-cid-types and must pin its major version alongside jmap-base-client.

The coupling is deliberate. jmap-cid-types is a workspace sibling of jmap-base-client (both live in the crate-jmap workspace) and ships in the same release cadence — every jmap-cid-types major bump is also a jmap-base-client major bump. The SemVer-isolation pattern that hides reqwest::Error behind HttpError is designed for third-party deps whose release cadence is uncorrelated with this crate’s; workspace siblings do not need that isolation because the workspace-level major-version policy already coordinates them.

Third-party consumers picking up jmap-base-client from crates.io should declare both deps with matching majors:

[dependencies]
jmap-base-client = "0.1"
jmap-cid-types   = "0.1"

If you only ever pattern-match on Option::Some(_) (without naming the inner type) you can skip the explicit jmap-cid-types dep; touching Sha256’s methods or AsRef<str> impl requires it.

§extra equality is feature-flag-dependent (bd:JMAP-6r7c.43)

The derived PartialEq / Eq impl’s behaviour on the extra field depends on the global serde_json/preserve_order feature flag — see the crate-level note for the canonical statement and the workspace posture.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§account_id: Id

The account the blob was uploaded to.

§blob_id: Id

Server-assigned opaque blob identifier.

§content_type: String

Media type of the uploaded blob as determined by the server.

§size: u64

Size of the uploaded blob in bytes.

§sha256: Option<Sha256>

SHA-256 digest of the uploaded blob, present only when the server advertises the urn:ietf:params:jmap:cid capability (draft-atwood-jmap-cid-00 §3).

The wire format is a 64-character lowercase-hex string per the draft’s ABNF (%x30-39 / %x61-66). The typed jmap_cid_types::Sha256 enforces that shape on deserialize: a server response carrying a sha256 field that is not exactly 64 bytes of lowercase hex will fail to parse and surface as ClientError::Parse. Servers that do not implement the CID extension omit the field; the typed representation here is None.

History: bd:JMAP-v9py.13 promoted this field from a permissive Option<String> to the typed Option<jmap_cid_types::Sha256>, and bd:JMAP-6r7c.48 propagated the same typed shape to the download-side DownloadBlobParams::expected_sha256 caller-supplied argument. The previous implementation tolerated uppercase hex via a permissive ad-hoc validator and a normalize- to-lowercase step before integrity comparison; the typed path is strict on every construction site. The inter-op question (whether to recover the uppercase tolerance via a custom Deserialize wrapper) is tracked by bd:JMAP-noz7.

§extra: Map<String, Value>

Catch-all for vendor / site / private extension fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace extras-preservation policy (see workspace AGENTS.md).

Trait Implementations§

Source§

impl Clone for BlobUploadResponse

Source§

fn clone(&self) -> BlobUploadResponse

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BlobUploadResponse

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for BlobUploadResponse

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for BlobUploadResponse

Source§

impl PartialEq for BlobUploadResponse

Source§

fn eq(&self, other: &BlobUploadResponse) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for BlobUploadResponse

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for BlobUploadResponse

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more