Struct ruma::api::client::r0::push::set_pushrule::Request [−][src]
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>,
}
api
and (crate features client-api
or client-api-c
or client-api-s
) only.Expand description
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: &'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
Trait Implementations
type Incoming = IncomingRequest
type Incoming = IncomingRequest
The ‘Incoming’ variant of Self
.
type EndpointError = Error
type EndpointError = Error
A type capturing the expected error conditions the server can return.
type IncomingResponse = <Response as Outgoing>::Incoming
type IncomingResponse = <Response as Outgoing>::Incoming
Response type returned when the request is successful.
pub fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
pub fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
Tries to convert this request into an http::Request
. Read more
Auto Trait Implementations
impl<'a> RefUnwindSafe for Request<'a>
impl<'a> UnwindSafe for Request<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: UserId
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: UserId
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
Tries to convert this request into an http::Request
and appends a virtual user_id
to
assert Appservice identity. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more