Skip to main content

InboundConfig

Struct InboundConfig 

Source
pub struct InboundConfig {
Show 22 fields pub up: i64, pub down: i64, pub total: i64, pub remark: String, pub sub_sort_index: i32, pub enable: bool, pub disable_flow: bool, pub expiry_time: i64, pub traffic_reset: TrafficReset, pub traffic_reset_day: u8, pub last_traffic_reset_time: i64, pub client_stats: Vec<ClientTraffic>, pub listen: String, pub port: u16, pub protocol: InboundProtocol, pub settings: Value, pub stream_settings: Value, pub tag: String, pub sniffing: Value, pub node_id: Option<i64>, pub share_addr_strategy: ShareAddressStrategy, pub share_addr: String,
}
Expand description

Complete writable configuration accepted by create, update, and import.

Use InboundConfig::new for safe panel defaults. Convert a fetched Inbound with Inbound::to_config before replacing it through InboundsApi::update. The open-ended JSON fields intentionally mirror Xray’s protocol-specific configuration fragments.

Fields§

§up: i64

Uploaded bytes to seed during import.

§down: i64

Downloaded bytes to seed during import.

§total: i64

Traffic limit in bytes, or zero when unlimited.

§remark: String

Human-readable label.

§sub_sort_index: i32

Position in subscription output; negatives are allowed, and zero normalizes to one.

§enable: bool

Whether the inbound is enabled.

§disable_flow: bool

Disables client flow values when generating subscription links.

§expiry_time: i64

Expiration timestamp in milliseconds, or zero when unlimited.

§traffic_reset: TrafficReset

Automatic traffic reset schedule.

§traffic_reset_day: u8

Day of month used by monthly reset schedules.

§last_traffic_reset_time: i64

Most recent automatic reset timestamp in milliseconds.

§client_stats: Vec<ClientTraffic>

Per-client traffic rows preserved by imports.

§listen: String

Local listen address, or an empty string for all interfaces.

§port: u16

Listen port; zero lets compatible server flows choose it.

§protocol: InboundProtocol

Xray inbound protocol.

§settings: Value

Protocol-specific Xray settings object.

§stream_settings: Value

Transport and security settings object.

§tag: String

Stable Xray tag; leave empty on create to let 3x-ui generate it.

§sniffing: Value

Xray sniffing settings object.

§node_id: Option<i64>

Hosting node identifier, or None for the local panel.

§share_addr_strategy: ShareAddressStrategy

Public share-address selection strategy.

§share_addr: String

Explicit share address used with the custom strategy.

Implementations§

Source§

impl InboundConfig

Source

pub fn new(protocol: InboundProtocol, port: u16) -> Self

Creates an enabled configuration with unlimited traffic and safe panel defaults.

Trait Implementations§

Source§

impl Clone for InboundConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InboundConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for InboundConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for InboundConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for InboundConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for InboundConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more