Struct AccessRule

pub struct AccessRule { /* private fields */ }

Available on crate feature access only.

Represents an access rule containing information about a principal and access grant status.

Implementations

impl AccessRule

pub fn new<T>(principal: T, is_granted: bool) -> Self

where T: Into<Principal>,

Creates a new AccessRule.

Arguments

• principal - A principal.
• is_granted - A flag indicating whether access is granted (true) or denied (false).

pub fn allow<T>(value: T) -> Self

where T: Into<Principal>,

Creates a new AccessRule with granted access for a principal.

Arguments

• value - The principal.

pub fn deny<T>(value: T) -> Self

where T: Into<Principal>,

Creates a new AccessRule with forbidden access for a principal.

Arguments

• value - The principal.

pub fn allow_all() -> Self

Creates a new AccessRule with granted access for all principals.

pub fn deny_all() -> Self

Creates a new AccessRule with denied access for all principals.

pub fn allow_user<T>(value: T) -> Self

where T: Into<UserId>,

Creates a new AccessRule with granted access for a specific user.

Arguments

• value - Identifier of the user.

pub fn deny_user<T>(value: T) -> Self

where T: Into<UserId>,

Creates a new AccessRule with denied access for a specific user.

Arguments

• value - Identifier of the user.

pub fn allow_chat<T>(value: T) -> Self

where T: Into<ChatId>,

Creates a new AccessRule with granted access for a specific chat.

Arguments

• value - Identifier of the chat.

pub fn deny_chat<T>(value: T) -> Self

where T: Into<ChatId>,

Creates a new AccessRule with denied access for a specific chat.

Arguments

• value - Identifier of the chat.

pub fn allow_chat_user<A, B>(chat_id: A, user_id: B) -> Self

where A: Into<ChatId>, B: Into<UserId>,

Creates a new AccessRule with granted access for a user within a specific chat.

Arguments

• chat_id - Identifier of the chat.
• user_id - Identifier of the user.

pub fn deny_chat_user<A, B>(chat_id: A, user_id: B) -> Self

where A: Into<ChatId>, B: Into<UserId>,

Creates a new AccessRule with denied access for a user within a specific chat.

Arguments

• chat_id - Identifier of the chat.
• user_id - Identifier of the user.

pub fn accepts(&self, update: &Update) -> bool

Indicates whether the AccessRule accepts an Update.

Arguments

• update - The update to be evaluated by the access rule.

Returns true if AccessRule accepts an update and false otherwise.

pub fn is_granted(&self) -> bool

Indicates whether access is granted by the rule.

Returns true if access is granted and false otherwise.

Trait Implementations

impl Debug for AccessRule

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

Formats the value using the given formatter.