Struct ruma::api::client::r0::push::set_pushrule_enabled::Request

pub struct Request<'a> {
    pub scope: &'a str,
    pub kind: RuleKind,
    pub rule_id: &'a str,
    pub enabled: bool,
}

This is supported on crate feature api and (crate features client-api or client-api-c or client-api-s) only.

Data for a request to the set_pushrule_enabled API endpoint.

This endpoint allows clients to enable or disable the specified push rule.

Fields

scope: &'a str

The scope to fetch a rule from. ‘global’ to specify global rules.

kind: RuleKind

The kind of rule

rule_id: &'a str

The identifier for the rule.

enabled: bool

Whether the push rule is enabled or not.

Implementations

impl<'a> Request<'a>

pub fn new(
    scope: &'a str,
    kind: RuleKind,
    rule_id: &'a str,
    enabled: bool
) -> Request<'a>

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

pub fn enable(scope: &'a str, kind: RuleKind, rule_id: &'a str) -> Request<'a>

Creates a new Request to enable the given rule.

pub fn disable(scope: &'a str, kind: RuleKind, rule_id: &'a str) -> Request<'a>

Creates a new Request to disable the given rule.

Trait Implementations

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

pub 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>

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

Formats the value using the given formatter.

impl<'a> Outgoing for Request<'a>

type Incoming = IncomingRequest

The ‘Incoming’ variant of Self.

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

type EndpointError = Error

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

type IncomingResponse = <Response as Outgoing>::Incoming

Response type returned when the request is successful.

pub const METADATA: Metadata

Metadata about the endpoint.

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.