Struct ruma_client_api::r0::push::set_pushrule::IncomingRequest

#[non_exhaustive]pub struct IncomingRequest {
    pub scope: String,
    pub kind: RuleKind,
    pub rule_id: String,
    pub before: Option<String>,
    pub after: Option<String>,
    pub actions: Vec<Action>,
    pub conditions: Vec<PushCondition>,
    pub pattern: Option<String>,
}

'Incoming' variant of Request.

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.

scope: String

The scope to set the rule in. 'global' to specify global rules.

kind: RuleKind

The kind of rule

rule_id: String

The identifier for the rule.

before: Option<String>

Use 'before' with a rule_id as its value to make the new rule the next-most important rule with respect to the given user defined rule.

after: Option<String>

This makes the new rule the next-less important rule relative to the given user defined rule.

actions: Vec<Action>

The actions to perform when this rule is matched.

conditions: Vec<PushCondition>

The conditions that must hold true for an event in order for a rule to be applied to an event. A rule with no conditions always matches. Only applicable to underride and override rules, empty Vec otherwise.

pattern: Option<String>

The glob-style pattern to match against. Only applicable to content rules.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

pub const METADATA: Metadata

Metadata for the set_pushrule API endpoint.

pub fn try_from_http_request(
    request: Request<Vec<u8>>
) -> Result<Self, FromHttpRequestError>

Tries to turn the given http::Request into this request type.