Struct ruma_client_api::push::set_pushrule_enabled::v3::Request

#[non_exhaustive]
pub struct Request {
    pub kind: RuleKind,
    pub rule_id: String,
    pub enabled: bool,
}

Request type for the set_pushrule_enabled endpoint.

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.

kind: RuleKind

The kind of rule

rule_id: String

The identifier for the rule.

enabled: bool

Whether the push rule is enabled or not.

Implementations

impl Request

pub fn new(kind: RuleKind, rule_id: String, enabled: bool) -> Self

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

pub fn enable(kind: RuleKind, rule_id: String) -> Self

Creates a new Request to enable the given rule.

pub fn disable(kind: RuleKind, rule_id: String) -> Self

Creates a new Request to disable the given rule.

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

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 = 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.