Struct Interest 

pub struct Interest {
    pub id: InterestId,
    pub mode: InterestMode,
    pub options: InterestOptions,
    pub wire_expr: Option<WireExpr<'static>>,
    pub ext_qos: QoSType,
    pub ext_tstamp: Option<TimestampType>,
    pub ext_nodeid: NodeIdType,
}

The INTEREST message is sent to request the transmission of current and optionally future declarations of a given kind matching a target keyexpr. E.g., an interest could be sent to request the transmission of all current subscriptions matching a/*.

The behaviour of a INTEREST depends on the INTEREST MODE.

E.g., the message flow is the following for an Interest with mode InterestMode::Current:

    A                   B
    |     INTEREST      |
    |------------------>| -- Mode: Current
    |                   |    This is an Interest e.g. for subscriber declarations.
    |                   |
    |  DECL SUBSCRIBER  |
    |<------------------| -- With interest_id field set
    |  DECL SUBSCRIBER  |
    |<------------------| -- With interest_id field set
    |  DECL SUBSCRIBER  |
    |<------------------| -- With interest_id field set
    |                   |
    |     DECL FINAL    |
    |<------------------| -- With interest_id field set
    |                   |

And the message flow is the following for an Interest with mode InterestMode::CurrentFuture:

    A                   B
    |     INTEREST      |
    |------------------>| -- This is a DeclareInterest e.g. for subscriber declarations/undeclarations.
    |                   |
    |  DECL SUBSCRIBER  |
    |<------------------| -- With interest_id field set
    |  DECL SUBSCRIBER  |
    |<------------------| -- With interest_id field set
    |  DECL SUBSCRIBER  |
    |<------------------| -- With interest_id field set
    |                   |
    |     DECL FINAL    |
    |<------------------| -- With interest_id field set
    |                   |
    |  DECL SUBSCRIBER  |
    |<------------------| -- With interest_id field not set
    | UNDECL SUBSCRIBER |
    |<------------------| -- With interest_id field not set
    |                   |
    |        ...        |
    |                   |
    | INTEREST FINAL    |
    |------------------>| -- Mode: Final
    |                   |    This stops the transmission of subscriber declarations/undeclarations.
    |                   |

And the message flow is the following for an Interest with mode InterestMode::Future:

    A                   B
    |     INTEREST      |
    |------------------>| -- This is a DeclareInterest e.g. for subscriber declarations/undeclarations.
    |                   |
    |  DECL SUBSCRIBER  |
    |<------------------| -- With interest_id field not set
    | UNDECL SUBSCRIBER |
    |<------------------| -- With interest_id field not set
    |                   |
    |        ...        |
    |                   |
    | INTEREST FINAL    |
    |------------------>| -- Mode: Final
    |                   |    This stops the transmission of subscriber declarations/undeclarations.
    |                   |

Flags:
- |: Mode           The mode of the interest*
-/
- Z: Extension      If Z==1 then at least one extension is present

7 6 5 4 3 2 1 0
+-+-+-+-+-+-+-+-+
|Z|Mod|INTEREST |
+-+-+-+---------+
~    id:z32     ~
+---------------+
|A|M|N|R|T|Q|S|K|  if Mod!=Final (*)
+---------------+
~ key_scope:z16 ~  if Mod!=Final && R==1
+---------------+
~  key_suffix   ~  if Mod!=Final && R==1 && N==1 -- <u8;z16>
+---------------+
~  [int_exts]   ~  if Z==1
+---------------+

Mode of declaration:
- Mode 0b00: Final
- Mode 0b01: Current
- Mode 0b10: Future
- Mode 0b11: CurrentFuture

(*) - if K==1 then the interest refers to key expressions
    - if S==1 then the interest refers to subscribers
    - if Q==1 then the interest refers to queryables
    - if T==1 then the interest refers to tokens
    - if R==1 then the interest is restricted to the matching key expression, else it is for all key expressions.
    - if N==1 then the key expr has name/suffix. If R==0 then N should be set to 0.
    - if M==1 then key expr mapping is the one declared by the sender, else it is the one declared by the receiver.
              If R==0 then M should be set to 0.
    - if A==1 then the replies SHOULD be aggregated

Fields

id: InterestId

mode: InterestMode

options: InterestOptions

wire_expr: Option<WireExpr<'static>>

ext_qos: QoSType

ext_tstamp: Option<TimestampType>

ext_nodeid: NodeIdType

Implementations

impl Interest

pub fn options(&self) -> u8

Trait Implementations

impl Clone for Interest

fn clone(&self) -> Interest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interest

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

Formats the value using the given formatter.

impl PartialEq for Interest

fn eq(&self, other: &Interest) -> 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 Eq for Interest

impl StructuralPartialEq for Interest