Struct ShutdownNotice

pub struct ShutdownNotice {}

Indicates that the websocket will shut down in the near future. Until it is, SubscriptionUpdates will still be sent to the client. Clients that want to avoid downtime or latency spikes should initiate a new websocket and recreate all their subscriptions there but still keep this websocket open until the new websockets starts sending SubscriptionUpdates. Note: The initial updates that the new websocket sends might be somewhat stale because of server and connection pools warm up. The client might want to wait with fully switching to the new subscription until the updates aren’t very stale anymore.

Implementations

impl ShutdownNotice

pub fn builder() -> Builder<Complete>

Returns a new builder.

impl ShutdownNotice

pub fn new() -> Self

Constructs a new instance of the type.

Trait Implementations

impl Clone for ShutdownNotice

fn clone(&self) -> ShutdownNotice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownNotice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShutdownNotice

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ShutdownNotice> for Builder<Complete>

fn from(v: ShutdownNotice) -> Self

Converts to this type from the input type.

impl Hash for ShutdownNotice

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ShutdownNotice

fn cmp(&self, other: &ShutdownNotice) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ShutdownNotice

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ShutdownNotice

fn partial_cmp(&self, other: &ShutdownNotice) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ShutdownNotice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ShutdownNotice

impl Eq for ShutdownNotice

impl StructuralPartialEq for ShutdownNotice