Skip to main content

Call

Struct Call 

Source
pub struct Call {
    pub operation: &'static str,
    pub method: Method,
    pub path: String,
    pub body: Option<Vec<u8>>,
}
Expand description

One control-plane call: method, path, optional JSON body.

A struct rather than a long parameter list because the recorder asserts on it as a whole, and because method and path next to each other is how a reader checks a path against the model’s http trait.

Fields§

§operation: &'static str

The operation name, for diagnostics and for the recorder’s ledger.

Carried rather than derived from the path: the recorder’s TRAP-11 assertion is “an exec lifecycle emits no call named CreateMicrovmShellAuthToken”, and matching that on a path is a substring test that a renamed route would slip past.

§method: Method

GET, POST, PATCH, or DELETE — the four the model’s http traits use for the operations this client implements.

§path: String

The path after the host, with the API version and every URI parameter already percent-encoded. Includes the query string when the operation has one.

§body: Option<Vec<u8>>

The rest-json body, or None for an operation the model gives no body members.

Implementations§

Source§

impl Call

Source

pub fn get(operation: &'static str, path: impl Into<String>) -> Self

A GET with no body.

Source

pub fn post_json<T: Serialize>( operation: &'static str, path: impl Into<String>, body: &T, ) -> Result<Self, Error>

A POST carrying a serialized rest-json body.

Source

pub fn patch_json<T: Serialize>( operation: &'static str, path: impl Into<String>, body: &T, ) -> Result<Self, Error>

A PATCH carrying a serialized rest-json body.

The same shape as Call::post_json and written beside it rather than folded into a method-taking constructor, for the reason Method’s docs give: the method is part of the route the model declares, and a with_method(Method::Patch) builder is one a call site can forget to call. UpdateMicrovmImageVersion is the only operation that reaches this.

Source

pub fn post_empty(operation: &'static str, path: impl Into<String>) -> Self

A POST with no body members. SuspendMicrovm and ResumeMicrovm are both this shape: their only member is the URI-located identifier.

The body is Some(b"{}") rather than None, because an empty POST and a POST of {} are different canonical requests and rest-json services answer the former inconsistently.

Source

pub fn delete(operation: &'static str, path: impl Into<String>) -> Self

A DELETE with no body.

Source

pub fn body_bytes(&self) -> &[u8] ⓘ

The body as bytes, empty when there is none — which is what gets signed.

Trait Implementations§

Source§

impl Clone for Call

Source§

fn clone(&self) -> Self

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 Call

Source§

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

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

impl Eq for Call

Source§

impl PartialEq for Call

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Call

Auto Trait Implementations§

§

impl Freeze for Call

§

impl RefUnwindSafe for Call

§

impl Send for Call

§

impl Sync for Call

§

impl Unpin for Call

§

impl UnsafeUnpin for Call

§

impl UnwindSafe for Call

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.