Struct ruma_client_api::push::set_pushrule::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub scope: &'a str,
    pub kind: RuleKind,
    pub rule_id: &'a str,
    pub before: Option<&'a str>,
    pub after: Option<&'a str>,
    pub actions: &'a [Action],
    pub conditions: &'a [PushCondition],
    pub pattern: Option<&'a str>,
}

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 (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: &'a str

The scope to set the rule in. ‘global’ to specify global rules.

kind: RuleKind

The kind of rule

rule_id: &'a str

The identifier for the rule.

before: Option<&'a str>

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<&'a str>

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

actions: &'a [Action]

The actions to perform when this rule is matched.

conditions: &'a [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<&'a str>

The glob-style pattern to match against.

Only applicable to content rules.

Implementations

impl<'a> Request<'a>

pub fn new(
    scope: &'a str,
    kind: RuleKind,
    rule_id: &'a str,
    actions: &'a [Action]
) -> Self

Creates a new Request with the given scope, rule kind, rule ID and actions.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> OutgoingRequest for Request<'a>

type EndpointError = Error

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_into_http_request<T: Default + BufMut>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>,
    considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>

Tries to convert this request into an http::Request.