Module message 

Control message types with encode/decode. Draft-19 control message encoding and decoding.

Key differences from draft-18:

• Request ID field removed from GOAWAY entirely; the control-stream and request-stream forms are now identical.
• New Range Filter parameters (length-prefixed): SUBGROUP_FILTER (0x25), OBJECTID_FILTER (0x26), PRIORITY_FILTER (0x27), OBJECT_PROPERTY_FILTER (0x28) and TRACK_PROPERTY_FILTER (0x29).
• New Setup Options MAX_FILTER_RANGES (0x06) and MAX_REQUEST_UPDATES (0x08); both are even KVP types carrying a varint value.
• GROUP_ORDER (0x22) moves from PUBLISH_OK to SUBSCRIBE_TRACKS (the wire encoding of the parameter is unchanged).
• PUBLISH_BLOCKED renamed to PUBLISH_SKIPPED (still type 0x0F; wire identical).
• SUBSCRIPTION_FILTER renamed to LOCATION_FILTER (still parameter 0x21).
• REQUEST_ERROR adds CONFLICTING_FILTERS (0x35) and INVALID_FILTER (0x36); DUPLICATE_SUBSCRIPTION (0x19) is removed.

Re-exports

pub use crate::error::CodecError;

pub use crate::error::MAX_GOAWAY_URI_LENGTH;

pub use crate::error::MAX_MESSAGE_LENGTH;

pub use crate::error::MAX_NAMESPACE_TUPLE_SIZE;

pub use crate::error::MAX_REASON_PHRASE_LENGTH;

Modules

publish_done_codes

Numeric values for the PublishDone::status_code field.

request_error_codes

REQUEST_ERROR error codes with dedicated meaning.

Structs

Fetch

FetchOk

FETCH_OK (0x18). end_of_track is uint8.

GoAway

GOAWAY (0x10). In draft-19 the Request ID field is removed, so the control-stream and request-stream forms are identical on the wire.

Namespace

NamespaceDone

Publish

PublishDone

PUBLISH_DONE (0x0B). Status codes 0x5/0x6 are swapped vs draft-17.

PublishNamespace

PublishSkipped

PUBLISH_SKIPPED (0x0F, renamed from PUBLISH_BLOCKED in draft-19; wire layout is unchanged).

Redirect

Optional Redirect structure carried in REQUEST_ERROR with code 0x34.

RequestError

REQUEST_ERROR (0x05). Adds an optional Redirect structure when error_code is REDIRECT (0x34).

RequestOk

REQUEST_OK (0x07). Used as a generic OK response and as the alias for PUBLISH_OK / REQUEST_UPDATE_OK / TRACK_STATUS_OK / SUBSCRIBE_NAMESPACE_OK / PUBLISH_NAMESPACE_OK.

RequestUpdate

Setup

Unified SETUP (0x2F00).

Subscribe

SubscribeNamespace

SUBSCRIBE_NAMESPACE (0x50). Subscribes to NAMESPACE / NAMESPACE_DONE advertisements for namespaces matching namespace_prefix. The subscribe_options byte from draft-17 is removed; namespace subscriptions only produce NAMESPACE / NAMESPACE_DONE.

SubscribeOk

SUBSCRIBE_OK (0x04).

SubscribeTracks

SUBSCRIBE_TRACKS (0x51, new in draft-18). Subscribes to PUBLISH messages for tracks whose namespace matches namespace_prefix. Carries the FORWARD parameter (which previously lived on SUBSCRIBE_NAMESPACE).

TrackStatus

Enums

ControlMessage

FetchPayload

FetchType

MessageType