xui-rs 1.0.1

A modern, typed async Rust SDK for the 3x-ui panel API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

//! A typed, asynchronous SDK for the complete 3x-ui v3.7.0 API.
//!
//! API tokens are the preferred authentication mechanism for automation.
//! Cookie sessions remain available for username/password and 2FA login flows,
//! and are required by the authenticated [`events`] stream.
//!
//! # Quick start
//!
//! ```no_run
//! use xui_rs::{Client, LoginRequest};
//!
//! # async fn run() -> xui_rs::Result<()> {
//! let client = Client::new("https://panel.example.com/secret/")?;
//! client
//!     .auth()
//!     .login(LoginRequest::new("admin", "password"))
//!     .await?;
//!
//! let status = client.server().status().await?;
//! println!("CPU: {:.1}%; Xray: {:?}", status.cpu, status.xray.state);
//!
//! client.auth().logout().await?;
//! # Ok(())
//! # }
//! ```
//!
//! Types are available both from the crate root for concise imports and from
//! domain modules such as [`inbounds`], [`clients`], [`server`], [`settings`],
//! [`hosts`], [`nodes`], [`panel`], [`events`], and [`subscription`] for
//! discoverable API documentation.

pub mod auth;
pub mod client;
pub mod clients;
pub mod error;
pub mod events;
pub mod hosts;
pub mod inbounds;
pub mod nodes;
pub mod panel;
pub mod proxy;
mod response;
mod transport;

#[cfg(test)]
mod remaining_http_contract_tests;

pub mod server;
pub mod settings;
pub mod subscription;
pub mod subscription_balancers;

pub use auth::{AuthApi, CsrfToken, LoginRequest};
pub use client::{
    AuthenticationKind, Client, ClientBuilder, DEFAULT_API_RESPONSE_BODY_LIMIT,
    DEFAULT_DOWNLOAD_RESPONSE_BODY_LIMIT,
};
pub use clients::{
    ActiveInboundsByGuid, AffectedCount, BulkAdjustRequest, BulkAdjustResult, BulkAttachResult,
    BulkClientIssue, BulkCreateResult, BulkDeleteResult, BulkDetachResult, BulkFlowAdjustment,
    BulkSetEnabledResult, ClientConfig, ClientCreateRequest, ClientDetails, ClientExternalLink,
    ClientExternalLinkInput, ClientExternalLinkKind, ClientHwidDevice, ClientIpEntry, ClientIpInfo,
    ClientIpsByGuid, ClientMutationStatus, ClientPage, ClientPageRequest, ClientRecord,
    ClientReverse, ClientSlim, ClientSort, ClientStatusFilter, ClientSummary,
    ClientWithAttachments, ClientsApi, ClientsByGuid, DeletedCount, GroupName, GroupSummary,
    LastOnlineByEmail, SortOrder,
};
pub use error::{Error, ErrorKind, Result};
pub use events::{
    ClientStatsUpdate, EventMessageType, EventStream, EventsApi, InboundTrafficSummary,
    Invalidation, NotificationLevel, PanelEvent, PanelEventKind, PanelNotification, TrafficDelta,
    TrafficUpdate, WebSocketClose, XrayStateChange,
};
pub use hosts::{
    HostGroup, HostJsonOverride, HostOptions, HostRow, HostSecurity, HostsApi, MihomoIpVersion,
    SubscriptionFormat, VlessRoute,
};
pub use inbounds::{
    AmneziaWgServerSettings, BulkDeleteClientsResult, BulkDeleteInboundsResult, ClientTraffic,
    ClientTrafficUsage, FallbackInput, FallbackParent, Inbound, InboundConfig, InboundFallback,
    InboundOption, InboundProtocol, InboundsApi, ShareAddressStrategy, SkippedClient,
    SkippedInbound, TrafficPushRequest, TrafficReset,
};
pub use nodes::{
    NodeInboundSyncMode, NodeMetric, NodeMtlsCa, NodeProbeResult, NodeRequest, NodeScheme,
    NodeStatus, NodeTlsVerifyMode, NodeUpdateChannel, NodeUpdateResult, NodeView, NodesApi,
    RemoteInboundOption, RemoteInboundProtocol,
};
pub use panel::{OpenApiDocument, PanelApi};
pub use proxy::{ProxyConfig, ProxyError, ProxyScheme};
pub use server::{
    AmneziaWgLogs, AmneziaWgPeerActivity, AmneziaWgStatus, AppStats, ClientIpObservation,
    ClientIpRecord, DatabaseFile, DiskIo, EchKeyPair, Fail2banStatus, HistoryBucket,
    LegacyCpuPoint, LogLevel, MetricPoint, Mldsa65KeyPair, Mlkem768KeyPair, NetworkIo,
    NetworkTraffic, NodeSummary, PanelLogRequest, PanelUpdateInfo, PanelUpdateRun,
    PanelUpdateState, PanelUpdateStatus, ProcessState, PublicAddresses, RealityScanRequest,
    RealityScanResult, ResourceUsage, ServerApi, ServerStatus, SystemMetric, VlessEncryptionAuth,
    VlessEncryptionOptions, WebCertificateFiles, X25519KeyPair, XrayConfig, XrayLogEntry,
    XrayLogEvent, XrayLogRequest, XrayMetric, XrayMetricsState, XrayObservatoryEntry, XrayStatus,
};
pub use settings::{
    ApiTokenCreateRequest, ApiTokenMetadata, ApiTokenScope, BalancerStatus, CreatedApiToken,
    DisplaySettings, EffectiveDefaults, FactoryDefaults, GeoCategory, GeoCategoryPage, GeoEntry,
    GeoEntryPage, GeoFile, GeodataTokenIssue, LdapSettings, MoveDirection, OutboundDocuments,
    OutboundSubscription, OutboundSubscriptionInput, OutboundTestMode, OutboundTestResult,
    OutboundTraffic, PanelSettings, PanelSettingsUpdate, PanelSettingsView, PiaAccount, PiaCountry,
    PiaKey, PiaRegion, PiaServer, PiaServers, RouteTestRequest, RouteTestResult, SecuritySettings,
    SensitivePayload, SettingsApi, SmtpSettings, SmtpTestResult, SubscriptionSettings,
    TelegramSettings, TestEgressResult, TestEndpointResult, UserCredentialsUpdate,
    WarpRegistration, WebSettings, XraySettingsApi, XraySettingsSnapshot,
};
pub use subscription::{
    DEFAULT_SUBSCRIPTION_RESPONSE_BODY_LIMIT, SubscriptionClient, SubscriptionClientBuilder,
    SubscriptionDecodeError, SubscriptionDevice, SubscriptionDocument, SubscriptionInfo,
    SubscriptionJson, SubscriptionMetadata, SubscriptionResponse, SubscriptionTraffic,
};
pub use subscription_balancers::{
    SubscriptionBalancer, SubscriptionBalancerInput, SubscriptionBalancerStrategy,
    SubscriptionBalancersApi,
};