Struct SystemOne 

pub struct SystemOne<'a, S, T: ?Sized, A = Answers> { /* private fields */ }

A System One request, ready to be configured and sent.

Made by Client::system_one. A is what the answers decode into: Answers, a lookup by question name, unless typed names a type of the caller’s own.

Nothing is checked or encoded until send: the methods never fail, and a header or a body member that cannot be sent is reported by send.

Implementations

impl<'a, S, T, A> SystemOne<'a, S, T, A>

where T: ?Sized,

pub fn model(self, model: impl Into<Cow<'a, str>>) -> Self

The model to ask, instead of the client’s default.

pub fn timeout(self, timeout: Duration) -> Self

The deadline of each attempt of this call, instead of the client’s.

pub fn no_timeout(self) -> Self

No deadline on any attempt of this call.

pub fn header( self, name: impl Into<Cow<'a, str>>, value: impl Into<Cow<'a, str>>, ) -> Self

A header for this call only. It replaces a client default of the same name; the SDK’s own headers still win over it, as they do over a default, and a later header of the same name replaces an earlier one. The headers the SDK or its transport owns are dropped without an error, as they are from a default; see ClientBuilder::default_header for the list, and for what Host does.

pub fn retry(self, policy: RetryPolicy) -> Self

The retry policy of this call, in place of the client’s; the client and its other calls keep theirs.

pub fn extra_body<V>(self, name: impl Into<Cow<'a, str>>, value: &V) -> Self

where V: Serialize + ?Sized,

A top-level member of the request body beside state, model and questions, for a parameter the API has and this SDK does not model.

Merging is last-write-wins, as in the Python SDK: a later member of the same name replaces an earlier one, and a member named state, model or questions replaces that built-in one in place. The value is encoded now; a value that cannot be encoded fails the call when it is sent.

pub fn typed<B>(self) -> SystemOne<'a, S, T, B>

where B: AnswerSet,

Decodes the answers into B instead: a struct with one field per question, for instance, which reads each answer straight into its field.

impl<S, T, A> SystemOne<'_, S, T, A>

where S: HttpService, T: Serialize + ?Sized, A: AnswerSet,

pub async fn send(self) -> Result<SystemOneResponse<A>, Error>

Sends the request and decodes the answer, retrying a failure as the call’s retry policy, or else the client’s, says.

The body is encoded once: every attempt sends the same bytes. When retrying stops, the error is the one the last attempt failed with.

Errors

• ErrorKind::InvalidRequest, before anything is sent: a header that is not a valid header, a deadline of zero, a state that is not a JSON string, object or array, or a value that cannot be encoded as JSON.
• ErrorKind::Api for a status outside 2xx.
• ErrorKind::Timeout when the attempt ran past its deadline.
• ErrorKind::Connection when no response could be read: the connection failed or broke.
• ErrorKind::ResponseTooLarge when a success response’s body was larger than the client’s limit.
• ErrorKind::ResponseValidation when the body does not decode into A.

Trait Implementations

impl<S, T, A> Debug for SystemOne<'_, S, T, A>

where T: ?Sized,

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

The request’s settings: no state, no header value and no body member, which are the caller’s data. A retry policy is shown when the call has one of its own.