Struct FerriskeySdk 

pub struct FerriskeySdk<T: Transport + Clone> { /* private fields */ }

FerrisKey SDK entrypoint parameterized by a transport implementation.

Type-Driven Design

The generic parameter T: Transport ensures that:

1. The transport type is known at compile time
2. Invalid transport configurations are caught before runtime
3. The compiler can optimize based on the concrete transport type

Builder Pattern

Use FerriskeySdk::builder() for a fluent, type-safe construction:

use ferriskey_sdk::{AuthStrategy, FerriskeySdk, HpxTransport, SdkConfig};

let config = SdkConfig::new("https://api.example.com", AuthStrategy::None);
let sdk = FerriskeySdk::builder(config).transport(HpxTransport::default()).build();

Implementations

impl<T: Transport + Clone> FerriskeySdk<T>

pub const fn new(config: SdkConfig, transport: T) -> Self

Construct a new SDK instance directly.

Prefer using Self::builder() for a more fluent API.

pub const fn builder(config: SdkConfig) -> FerriskeySdkBuilder<T, Unconfigured>

Create a typed builder with the required configuration.

The builder ensures the transport is set before calling .build().

pub const fn config(&self) -> &SdkConfig

Access the SDK configuration.

pub const fn transport(&self) -> &T

Access the underlying transport.

pub const fn operations(&self) -> &'static [GeneratedOperationDescriptor]

Access the full generated operation registry.

pub const fn tag(&self, tag: &'static str) -> TagClient<'_, T>

Access a tag-scoped SDK view.

pub fn operation(&self, operation_id: &str) -> Option<OperationCall<'_, T>>

Resolve a generated operation by its operation ID.

pub fn execute_operation( &self, operation_id: &str, input: OperationInput, ) -> Pin<Box<dyn Future<Output = Result<SdkResponse, SdkError>> + Send + '_>>

where <T as Service<SdkRequest>>::Future: Send,

Execute a generated operation through the canonical SDK request path.

pub fn prepare_request( &self, request: SdkRequest, ) -> Result<SdkRequest, SdkError>

Prepare a request by resolving its URL and applying auth.

Design Decision: Result Type

Returns Result<SdkRequest, SdkError> rather than panicking, enabling callers to handle configuration errors gracefully.

pub fn execute( &self, request: SdkRequest, ) -> Pin<Box<dyn Future<Output = Result<SdkResponse, SdkError>> + Send + '_>>

where <T as Service<SdkRequest>>::Future: Send,

Execute a request through the configured transport.

Uses tower::ServiceExt::oneshot for clean single-request execution.

pub fn execute_json<Output>( &self, request: SdkRequest, expected_status: u16, ) -> Pin<Box<dyn Future<Output = Result<Output, SdkError>> + Send + '_>>

where Output: DeserializeOwned + Send + 'static, <T as Service<SdkRequest>>::Future: Send,

Execute a request and decode a JSON response for the expected status.

Trait Implementations

impl<T: Clone + Transport + Clone> Clone for FerriskeySdk<T>

fn clone(&self) -> FerriskeySdk<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Transport + Clone> Debug for FerriskeySdk<T>

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

Formats the value using the given formatter.

impl<T: Transport + Clone> SdkExt for FerriskeySdk<T>

type Transport = T

The transport type for this SDK.

fn with_transport(config: SdkConfig, transport: T) -> Self

Create an SDK with a fluent one-liner.