Struct poster::DisconnectOpts

source ·
pub struct DisconnectOpts<'a> { /* private fields */ }
Expand description

Disconnection options, represented as a consuming builder. Used during disconnection request, translated to the DISCONNECT packet.

Implementations§

source§

impl<'a> DisconnectOpts<'a>

source

pub fn new() -> Self

Creates a new DisconnectOpts instance.

source

pub fn reason(self, reason: DisconnectReason) -> Self

Sets a reason for disconnection.

source

pub fn session_expiry_interval(self, val: Duration) -> Self

Sets session expiration interval.

§Arguments

val - Duration value less than u32::MAX in seconds.

§Panics

When the duration in seconds is greater than u32::MAX.

source

pub fn reason_string(self, val: &'a str) -> Self

Sets a reason string property.

source

pub fn user_property(self, (key, val): (&'a str, &'a str)) -> Self

Sets user properties. Multiple user properties may be set.

Trait Implementations§

source§

impl<'a> Default for DisconnectOpts<'a>

source§

fn default() -> DisconnectOpts<'a>

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

Auto Trait Implementations§

§

impl<'a> Freeze for DisconnectOpts<'a>

§

impl<'a> RefUnwindSafe for DisconnectOpts<'a>

§

impl<'a> Send for DisconnectOpts<'a>

§

impl<'a> Sync for DisconnectOpts<'a>

§

impl<'a> Unpin for DisconnectOpts<'a>

§

impl<'a> UnwindSafe for DisconnectOpts<'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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.