Struct Gate 

pub struct Gate { /* private fields */ }

Available on crate feature server only.

HTTP payment gate.

Implementations

impl Gate

pub fn error_response(&self, err: GateError) -> Response

Converts a GateError into an HTTP response.

impl Gate

pub const fn resource_server(&self) -> &ResourceServer

Resource server (facilitator + schemes).

pub fn accepts(&self) -> &[PriceTag]

Accepted price tags.

pub const fn resource(&self) -> &ResourceInfo

Resource metadata on 402 bodies.

pub const fn payment_required(&self) -> Option<&PaymentRequired>

Built 402 body, if Self::build_payment_required ran.

pub async fn require_schemes(&self) -> Result<(), GateError>

Requires a registered scheme for every accept. Escrow needs settle_on_cancel.

Errors

GateError::MissingScheme, GateError::MissingSettleOnCancel, or flow errors.

pub fn assert_mode_compatible( &self, mode: SettlementMode, ) -> Result<(), GateError>

Concurrent/Background are illegal when any resolved accept is upfront or escrow.

Errors

GateError::IncompatibleSettlementMode or flow-resolution errors.

pub async fn handle_request<S>( &self, inner: S, req: Request, ) -> Result<Response, GateError>

where S: Service<Request, Response = Response, Error = Infallible>, S::Future: Send,

Sequential: verify → settle-before → handler → finish(after-handler).

Handler 4xx/5xx never enter finish. Transport maps to 502 at the layer.

Errors

GateError for verify/settle/header failures.

pub async fn handle_request_concurrent<S>( &self, inner: S, req: Request, ) -> Result<Response, GateError>

where S: Service<Request, Response = Response, Error = Infallible> + Send, S::Future: Send,

Concurrent: steps 1–5, then wrap 4xx/overrides as Err, then run JoinSettle.

Errors

GateError for verify/settle/header failures. Overrides → 402 GateError::SettlementAborted.

pub async fn handle_request_background<S>( &self, inner: S, req: Request, ) -> Result<Response, GateError>

where S: Service<Request, Response = Response, Error = Infallible> + Send, S::Future: Send,

Background: steps 1–5, then run SpawnSettle, strip overrides, no receipt.

Errors

GateError for verify/header failures. Settlement errors are not returned.

impl Gate

pub async fn build_payment_required(&mut self) -> Result<(), GateError>

Fetches /supported and builds the shared 402 body.

Errors

GateError::Transport when /supported fails. GateError::FacilitatorSupport when this accept list has no matching kind or advertised extra is unusable. GateError::PaymentRequiredBuild when 402 construction fails.

pub async fn verify_only( &self, headers: &HeaderMap, ) -> Result<VerifiedPayment, GateError>

Verifies Payment-Signature against the built 402 accepts.

Errors

Missing/malformed header → 402. Transport → 502. isValid: false → 402/412.

Trait Implementations

impl Debug for Gate

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

Formats the value using the given formatter.