Struct SubscribeRequest 

#[non_exhaustive]
pub struct SubscribeRequest {
    pub harness: Option<String>,
    pub session: Option<String>,
}

Request of usage.steps.subscribe: {} for every notice, or {harness, session} for the notices of one session. The provider refuses an unknown member malformed, and so does this type.

harness and session are both optional and also accept null; each must be given together with the other or not at all. This type does not check that pairing: the provider refuses a request naming only one invalid_request, as it does for limit. See SubscribeRequest::check_pairing.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

harness: Option<String>

The producer to follow; see StepRow::harness.

session: Option<String>

The session to follow, matched exactly.

Implementations

impl SubscribeRequest

pub fn new() -> Self

Notices for every session.

pub fn for_session( self, harness: impl Into<String>, session: impl Into<String>, ) -> Self

Notices only when a row of this harness and session is committed.

pub fn check_pairing(&self) -> Result<(), &'static str>

Reports a request naming only one of harness and session. The pair comes together or not at all; the provider refuses a request that names one alone invalid_request. Both together and neither are fine.

Trait Implementations

impl Clone for SubscribeRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscribeRequest

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

Formats the value using the given formatter.

impl Default for SubscribeRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscribeRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SubscribeRequest

impl PartialEq for SubscribeRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SubscribeRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SubscribeRequest