Skip to main content

Crate gproxy_channel_api

Crate gproxy_channel_api 

Source
Expand description

Stable contracts for compile-time GPROXY channel extensions.

Re-exports§

pub use channel::Channel;
pub use context::PrepareCtx;
pub use context::RefreshCtx;
pub use context::ShapeCtx;
pub use context::TransportKind;
pub use disposition::Disposition;
pub use error::ChannelError;
pub use login::AuthCodeExchangeCtx;
pub use login::AuthCodeStart;
pub use login::AuthCodeStartCtx;
pub use login::ChannelLogin;
pub use login::CookieExchangeCtx;
pub use login::DeviceInit;
pub use login::DevicePoll;
pub use login::DevicePollCtx;
pub use login::DeviceStartCtx;
pub use metadata::ChannelCatalogEntry;
pub use metadata::ChannelMetadata;
pub use metadata::ChannelSettingField;
pub use metadata::ChannelSource;
pub use metadata::CredentialFamily;
pub use metadata::LoginMode;
pub use metadata::SettingControl;
pub use prepared::PreparedRequest;
pub use registration::ChannelRegistration;
pub use registration::RegisteredChannel;
pub use transport::ByteStreamDecoder as ChannelStreamDecoder;
pub use usage::RateLimitResetCreditConsumeOutcome;
pub use usage::RateLimitResetCreditConsumeResponse;
pub use usage::RateLimitResetCredits;
pub use usage::UsageCredits;
pub use usage::UsageSnapshot;
pub use usage::UsageWindow;
pub use gproxy_protocol as protocol;
pub use gproxy_transform as transform;

Modules§

channel
Core channel adapter contract.
context
Input contexts passed to channel hooks.
disposition
Upstream response classification (§6.4).
error
Errors returned by channel adapters.
login
OAuth authorization-code login for channels (§14.5).
metadata
Self-description used by the Admin API and generic Console forms.
prepared
The output of Channel::prepare.
registration
Compile-time registration contract for externally linked channel crates.
routes
A channel’s explicit routing surface — the verbatim port of v1’s per-channel routing_table(). A channel declares, for each (operation, inbound kind) cell it can serve, how to service it (RoutingDecision). seed_default_routing materializes this list into real routing_rules rows; cells the channel does not declare have no rule and are Unsupported at request time.
transport
Host-provided upstream transport capability available to channel adapters.
usage
Per-credential upstream usage / quota snapshot (§17). OAuth subscription channels expose a usage endpoint that reports the account’s rate-limit windows and (where applicable) credit balance for a single credential. Each channel parses its provider-specific response into this shared shape; the raw upstream JSON is retained in UsageSnapshot::raw so the admin UI can surface fields this normalization does not model.