Struct SdkRequest 

pub struct SdkRequest {
    pub body: Option<Vec<u8>>,
    pub requires_auth: bool,
    pub headers: BTreeMap<String, String>,
    pub method: String,
    pub path: String,
}

Canonical SDK request passed to a transport implementation.

Type Safety

The builder pattern ensures required fields are set at compile time. Use SdkRequest::builder() to construct requests with guaranteed validity.

Fields

body: Option<Vec<u8>>

Raw request body bytes.

requires_auth: bool

Whether the request requires bearer authentication.

headers: BTreeMap<String, String>

Header values to attach to the outgoing request.

method: String

HTTP method to execute.

path: String

Absolute or relative path for the request.

Implementations

impl SdkRequest

pub fn builder( method: impl Into<String>, path: impl Into<String>, ) -> SdkRequestBuilder<MethodSet, PathSet>

Create a typed builder for constructing requests.

Examples

use ferriskey_sdk::SdkRequest;

let request = SdkRequest::builder("GET", "/api/users")
    .header("accept", "application/json")
    .auth_required(true)
    .build();

pub fn new(method: impl Into<String>, path: impl Into<String>) -> Self

Construct a request with an HTTP method and request path. Prefer using Self::builder() for more complex requests.

Trait Implementations

impl Clone for SdkRequest

fn clone(&self) -> SdkRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SdkRequest

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

Formats the value using the given formatter.

impl PartialEq for SdkRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Service<SdkRequest> for HpxTransport

Implement tower::Service for HpxTransport.

This makes HpxTransport composable with any tower middleware.

type Response = SdkResponse

Responses given by the service.

type Error = TransportError

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<SdkResponse, TransportError>> + Send>>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, request: SdkRequest) -> Self::Future

Process the request and return the response asynchronously.

impl Eq for SdkRequest

impl StructuralPartialEq for SdkRequest