IdentifyPayload

Struct IdentifyPayload 

Source
pub struct IdentifyPayload<'a> {
    pub token: Cow<'a, str>,
    pub intents: Intents,
    pub properties: ConnectionProperties<'a>,
    pub compress: Option<bool>,
    pub large_threshold: Option<u8>,
    pub shard: Option<[u16; 2]>,
    pub presence: Option<PresenceUpdate>,
}
Expand description

Payload for the Identify opcode (op 2).

Sent to authenticate and start a new session.

Fields§

§token: Cow<'a, str>

Authentication token.

§intents: Intents

Gateway intents.

§properties: ConnectionProperties<'a>

Connection properties.

§compress: Option<bool>

Whether to enable payload compression.

§large_threshold: Option<u8>

Threshold for large guilds (50-250, default 50).

§shard: Option<[u16; 2]>

Shard information: [shard_id, total_shards].

§presence: Option<PresenceUpdate>

Initial presence.

Implementations§

Source§

impl<'a> IdentifyPayload<'a>

Source

pub fn new(token: impl Into<Cow<'a, str>>, intents: Intents) -> Self

Create a new Identify payload with required fields.

Source

pub fn with_shard(self, shard_id: u16, total_shards: u16) -> Self

Set shard information.

Trait Implementations§

Source§

impl<'a> Clone for IdentifyPayload<'a>

Source§

fn clone(&self) -> IdentifyPayload<'a>

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
Source§

impl<'a> Debug for IdentifyPayload<'a>

Source§

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

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

impl<'a> Serialize for IdentifyPayload<'a>

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

Auto Trait Implementations§

§

impl<'a> Freeze for IdentifyPayload<'a>

§

impl<'a> RefUnwindSafe for IdentifyPayload<'a>

§

impl<'a> Send for IdentifyPayload<'a>

§

impl<'a> Sync for IdentifyPayload<'a>

§

impl<'a> Unpin for IdentifyPayload<'a>

§

impl<'a> UnwindSafe for IdentifyPayload<'a>

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> 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> 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 = Infallible

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

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

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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