canic_core::api::access::auth

Struct AuthApi

pub struct AuthApi;

Expand description

AuthApi

Implementations§

Source §

pub async fn is_app_directory_role( caller: Principal, role: CanisterRole, ) -> Result<(), PublicError>

Source

pub async fn is_child(caller: Principal) -> Result<(), PublicError>

Source

pub async fn is_controller(caller: Principal) -> Result<(), PublicError>

Source

pub async fn is_parent(caller: Principal) -> Result<(), PublicError>

Source

pub async fn is_principal( caller: Principal, expected: Principal, ) -> Result<(), PublicError>

Source

pub async fn is_registered_to_subnet( caller: Principal, ) -> Result<(), PublicError>

Source

pub async fn is_root(caller: Principal) -> Result<(), PublicError>

Source

pub async fn is_same_canister(caller: Principal) -> Result<(), PublicError>

Source

pub async fn is_subnet_directory_role( caller: Principal, role: CanisterRole, ) -> Result<(), PublicError>

Source

pub async fn is_whitelisted(caller: Principal) -> Result<(), PublicError>

Auto Trait Implementations§

§

impl Freeze for AuthApi

§

impl RefUnwindSafe for AuthApi

§

impl Send for AuthApi

§

impl Sync for AuthApi

§

impl Unpin for AuthApi

§

impl UnwindSafe for AuthApi

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> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> Same for T

Source §

type Output = T

Should always be Self

Source §

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source §

AuthApi

Struct AuthApi Copy item path

Implementations§

impl AuthApi

pub async fn require_all(rules: Vec<AuthRuleFn>) -> Result<(), PublicError>

pub async fn require_any(rules: Vec<AuthRuleFn>) -> Result<(), PublicError>

pub async fn is_app_directory_role( caller: Principal, role: CanisterRole, ) -> Result<(), PublicError>

pub async fn is_child(caller: Principal) -> Result<(), PublicError>

pub async fn is_controller(caller: Principal) -> Result<(), PublicError>

pub async fn is_parent(caller: Principal) -> Result<(), PublicError>

pub async fn is_principal( caller: Principal, expected: Principal, ) -> Result<(), PublicError>

pub async fn is_registered_to_subnet( caller: Principal, ) -> Result<(), PublicError>

pub async fn is_root(caller: Principal) -> Result<(), PublicError>

pub async fn is_same_canister(caller: Principal) -> Result<(), PublicError>

pub async fn is_subnet_directory_role( caller: Principal, role: CanisterRole, ) -> Result<(), PublicError>

pub async fn is_whitelisted(caller: Principal) -> Result<(), PublicError>

Auto Trait Implementations§

impl Freeze for AuthApi

impl RefUnwindSafe for AuthApi

impl Send for AuthApi

impl Sync for AuthApi

impl Unpin for AuthApi

impl UnwindSafe for AuthApi

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Same for T

type Output = T

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

Struct AuthApi

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

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

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

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

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,