Struct ruma::api::client::push::set_pushrule::v3::IncomingRequest

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, Global>,
    pub conditions: Vec<PushCondition, Global>,
    pub pattern: Option<String>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

‘Incoming’ variant of Request.

Fields

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, Global>

The actions to perform when this rule is matched.

conditions: Vec<PushCondition, Global>

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

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

Available on crate feature server only.

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.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<IncomingRequest, FromHttpRequestError>where
    B: AsRef<[u8]>,
    S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.