Skip to main content

HandshakeConfig

aerosocket_core::handshake

Struct HandshakeConfig

pub struct HandshakeConfig {
    pub protocols: Vec<String>,
    pub extensions: Vec<String>,
    pub origin: Option<String>,
    pub allowed_origins: Vec<String>,
    pub host: Option<String>,
    pub auth: Option<Auth>,
    pub compression: CompressionConfig,
    pub extra_headers: HashMap<String, String>,
}

Expand description

WebSocket handshake configuration

Fields§

§protocols: Vec<String>

WebSocket protocols to offer/accept

§extensions: Vec<String>

WebSocket extensions to offer/accept

§origin: Option<String>

Origin to send (client only)

§allowed_origins: Vec<String>

Allowed origins for CORS (server only, empty means allow all)

§host: Option<String>

Host header value (client only)

§auth: Option<Auth>

Authentication

§compression: CompressionConfig

Compression configuration

§extra_headers: HashMap<String, String>

Additional headers

Trait Implementations§

impl Clone for HandshakeConfig

fn clone(&self) -> HandshakeConfig

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 HandshakeConfig

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

Formats the value using the given formatter. Read more

impl Default for HandshakeConfig

fn default() -> HandshakeConfig

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

Auto Trait Implementations§

impl Freeze for HandshakeConfig

impl RefUnwindSafe for HandshakeConfig

impl Send for HandshakeConfig

impl Sync for HandshakeConfig

impl Unpin for HandshakeConfig

impl UnsafeUnpin for HandshakeConfig

impl UnwindSafe for HandshakeConfig

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> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

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, 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> LayoutRaw for T

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.

impl<T> Pointee for T

type Metadata = ()

The metadata type for pointers and references to this type.

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