Struct ruma_client_api::r0::push::set_pushrule::Request

pub struct Request {
    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>,
}

Data for a request to the set_pushrule API endpoint.

This endpoint allows the creation, modification and deletion of pushers for this user ID.

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>

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 Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Endpoint for Request

type Response = Response

Data returned in a successful response from the endpoint.

type ResponseError = Error

Error type returned when response from endpoint fails.

const METADATA: Metadata

Metadata for the #name endpoint.

impl Outgoing for Request

type Incoming = Self

The 'Incoming' variant of Self.

impl TryFrom<Request<Vec<u8>>> for Request

type Error = FromHttpRequestError

The type returned in the event of a conversion error.

fn try_from(request: Request<Vec<u8>>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Request> for Request<Vec<u8>>

type Error = IntoHttpError

The type returned in the event of a conversion error.

fn try_from(request: Request) -> Result<Self, Self::Error>

Performs the conversion.