Skip to main content

PublishDone

Struct PublishDone 

Source
pub struct PublishDone {
    pub status_code: VarInt,
    pub stream_count: VarInt,
    pub reason_phrase: Vec<u8>,
}
Expand description

PUBLISH_DONE (0x0B). The wire layout is unchanged from draft-19; what draft-20 changed is the Stream Count sentinel, what the count includes, and the removal of status code 0x3.

Fields§

§status_code: VarInt

The reason the publisher is ending the subscription.

Not validated against the registry, on decode or on encode, and that is the draft’s instruction rather than an omission. Draft-20 Section 14: “Receipt of an unknown error code in any error context (Session Termination, REQUEST_ERROR, PUBLISH_DONE, or Data Stream Reset) MUST be treated as equivalent to INTERNAL_ERROR for that context. An endpoint MUST NOT close the session because it received an unknown error code in a REQUEST_ERROR or PUBLISH_DONE.” Refusing the frame would take that choice away from the caller, so an unassigned code is carried up and super::error_codes::PublishDoneStatusCode::from_u64 answers None for it.

That reaches 0x3 in particular. Draft-19 assigned it to SUBSCRIPTION_ENDED; draft-20 removed the row and the behaviour behind it together (Section 5.1.2: “A publisher does not end a subscription solely because the Largest Object advances past the end of the current Location Filter”). A draft-20 receiver reads a 0x3 as INTERNAL_ERROR.

§stream_count: VarInt

The number of streams the publisher opened for this subscription.

Draft-20 Section 10.12 widens what is counted: the total now includes “streams that contained no Objects (e.g., an empty Subgroup) and including any fill fetch streams (see Section 5.1.3)”. Draft-19 counted no fill streams because it had none.

See publish_done_codes::STREAM_COUNT_UNKNOWN for the sentinel.

§reason_phrase: Vec<u8>

Trait Implementations§

Source§

impl Clone for PublishDone

Source§

fn clone(&self) -> PublishDone

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PublishDone

Source§

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

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

impl Eq for PublishDone

Source§

impl PartialEq for PublishDone

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PublishDone

Auto Trait Implementations§

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

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

fn try_from(value: U) -> Result<T, !>

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.