Skip to main content

TopicAuth

Struct TopicAuth 

Source
pub struct TopicAuth { /* private fields */ }
Expand description

Topic authorization engine.

Holds a set of rules that map topic patterns to access policies. When checking access, the first matching rule wins. If no rule matches, a configurable default policy applies (defaults to Public for subscribe, Authenticated for publish).

Implementations§

Source§

impl TopicAuth

Source

pub fn with_defaults() -> Self

Create with default rules for the standard topic namespaces.

Default rules:

  • system/# — subscribe: Authenticated, publish: never (internal only)
  • plugin/# — subscribe: Public, publish: Authenticated
  • custom/# — subscribe: Public, publish: Authenticated
Source

pub fn new() -> Self

Create with no rules (everything falls through to defaults).

Source

pub fn with_rules(rules: Vec<AuthRule>) -> Self

Create with custom rules.

Source

pub fn set_default_subscribe(&mut self, policy: Policy)

Override the default subscribe policy.

Source

pub fn set_default_publish(&mut self, policy: Policy)

Override the default publish policy.

Source

pub fn add_rule(&mut self, rule: AuthRule)

Add a rule.

Source

pub fn check_subscribe(&self, topic: &str, ctx: &AuthContext) -> bool

Check if the given context is allowed to subscribe to topic.

Source

pub fn check_publish(&self, topic: &str, ctx: &AuthContext) -> bool

Check if the given context is allowed to publish to topic.

Source

pub fn rules(&self) -> &[AuthRule]

Return the list of rules.

Trait Implementations§

Source§

impl Clone for TopicAuth

Source§

fn clone(&self) -> TopicAuth

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TopicAuth

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TopicAuth

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more