ServerConfig

aerosocket_server::config

Struct ServerConfig

pub struct ServerConfig {Show 14 fields
    pub bind_address: SocketAddr,
    pub max_connections: usize,
    pub max_frame_size: usize,
    pub max_message_size: usize,
    pub handshake_timeout: Duration,
    pub idle_timeout: Duration,
    pub compression: CompressionConfig,
    pub backpressure: BackpressureConfig,
    pub tls: Option<TlsConfig>,
    pub transport_type: TransportType,
    pub supported_protocols: Vec<String>,
    pub supported_extensions: Vec<String>,
    pub allowed_origin: Option<String>,
    pub extra_headers: HashMap<String, String>,
}

Expand description

Server configuration

Fields§

§bind_address: SocketAddr

Bind address

§max_connections: usize

Maximum concurrent connections

§max_frame_size: usize

Maximum frame size in bytes

§max_message_size: usize

Maximum message size in bytes

§handshake_timeout: Duration

Handshake timeout

§idle_timeout: Duration

Idle timeout

§compression: CompressionConfig

Compression configuration

§backpressure: BackpressureConfig

Backpressure configuration

§tls: Option<TlsConfig>

TLS configuration

§transport_type: TransportType

Transport type

§supported_protocols: Vec<String>

Supported WebSocket subprotocols

§supported_extensions: Vec<String>

Supported WebSocket extensions

§allowed_origin: Option<String>

Allowed origin (for CORS)

§extra_headers: HashMap<String, String>

Extra headers to send in handshake response

Implementations§

impl ServerConfig

pub fn validate(&self) -> Result<()>

Validate the configuration

Trait Implementations§

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ServerConfig

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

Formats the value using the given formatter. Read more

impl Default for ServerConfig

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl Freeze for ServerConfig

impl RefUnwindSafe for ServerConfig

impl Send for ServerConfig

impl Sync for ServerConfig

impl Unpin for ServerConfig

impl UnwindSafe for ServerConfig

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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