View Source Rolex.Control (Rolex v0.5.3)

Provides functions for granting, denying, and revoking permissions.

Summary

Types

any_from_opt()

any_on_opt()

any_role()

any_role_opt()

any_scope()

any_to_opt()

from_opt()

multi()

on_opt()

role()

role_opt()

scope()

to_opt()

Functions

deny(opts \\ [])

Creates a role-denying permission from DSL options.

deny!(opts \\ [])

Creates a role-denying permission from DSL options.

deny_on(object, opts \\ [])

Creates a role-denying permission from DSL options, prefilling on: object.

deny_on!(object, opts \\ [])

Creates a role-denying permission from DSL options, prefilling on: object.

deny_role(role, opts \\ [])

Creates a role-denying permission from DSL options, prefilling role: role.

deny_role!(role, opts \\ [])

Creates a role-denying permission from DSL options, prefilling role: role.

deny_to(subject, opts \\ [])

Creates a role-denying permission from DSL options, prefilling to: subject.

deny_to!(subject, opts \\ [])

Creates a role-denying permission from DSL options, prefilling to: subject.

grant(opts \\ [])

Creates a role-granting permission from DSL options.

grant!(opts \\ [])

Creates a role-granting permission from DSL options.

grant_on(object, opts \\ [])

Creates a role-granting permission from DSL options, prefilling on: object.

grant_on!(object, opts \\ [])

Creates a role-granting permission from DSL options, prefilling on: object.

grant_role(role, opts \\ [])

Creates a role-granting permission from DSL options, prefilling role: role.

grant_role!(role, opts \\ [])

Creates a role-granting permission from DSL options, prefilling role: role.

grant_to(subject, opts \\ [])

Creates a role-granting permission from DSL options, prefilling to: subject.

grant_to!(subject, opts \\ [])

Creates a role-granting permission from DSL options, prefilling to: subject.

multi_deny(multi, opts \\ [])

Adds a multi operation to create a role-denying permission from DSL options.

multi_deny_on(multi, object, opts \\ [])

Adds a multi operation to create a role-denying permission from DSL options, prefilling on: object.

multi_deny_role(multi, role, opts \\ [])

Adds a multi operation to create a role-denying permission from DSL options, prefilling role: role.

multi_deny_to(multi, subject, opts \\ [])

Adds a multi operation to create a role-denying permission from DSL options, prefilling to: subject.

multi_grant(multi, opts \\ [])

Adds a multi operation to create a role-granting permission from DSL options.

multi_grant_on(multi, object, opts \\ [])

Adds a multi operation to create a role-granting permission from DSL options, prefilling on: object.

multi_grant_role(multi, role, opts \\ [])

Adds a multi operation to create a role-granting permission from DSL options, prefilling role: role.

multi_grant_to(multi, subject, opts \\ [])

Adds a multi operation to create a role-granting permission from DSL options, prefilling to: subject.

multi_revoke(multi, opts \\ [])

Adds a multi operation to delete all permissions matching the given DSL options.

multi_revoke_from(multi, subject, opts \\ [])

Adds a multi operation to delete all permissions matching the given DSL options, prefilling from: subject.

multi_revoke_on(multi, object, opts \\ [])

Adds a multi operation to delete all permissions matching the given DSL options, prefilling on: object.

multi_revoke_role(multi, role, opts \\ [])

Adds a multi operation to delete all permissions matching the given DSL options, prefilling role: role.

revoke(opts \\ [])

Deletes all permissions matching the given DSL options.

revoke!(opts \\ [])

Deletes all permissions matching the given DSL options.

revoke_from(subject, opts \\ [])

Deletes all permissions matching the given DSL options, prefilling from: subject.

revoke_from!(subject, opts \\ [])

Deletes all permissions matching the given DSL options, prefilling from: subject.

revoke_on(object, opts \\ [])

Deletes all permissions matching the given DSL options, prefilling on: object.

revoke_on!(object, opts \\ [])

Deletes all permissions matching the given DSL options, prefilling on: object.

revoke_role(role, opts \\ [])

Deletes all permissions matching the given DSL options, prefilling role: role.

revoke_role!(role, opts \\ [])

Deletes all permissions matching the given DSL options, prefilling role: role.

Types

any_from_opt()

@type any_from_opt() :: Rolex.DSL.any_from_opt()

any_on_opt()

@type any_on_opt() :: Rolex.DSL.any_on_opt()

any_role()

@type any_role() :: Rolex.DSL.any_role()

any_role_opt()

@type any_role_opt() :: Rolex.DSL.any_role_opt()

any_scope()

@type any_scope() :: Rolex.DSL.any_scope()

any_to_opt()

@type any_to_opt() :: Rolex.DSL.any_to_opt()

from_opt()

@type from_opt() :: Rolex.DSL.from_opt()

multi()

@type multi() :: Ecto.Multi.t()

on_opt()

@type on_opt() :: Rolex.DSL.on_opt()

role()

@type role() :: Rolex.DSL.role()

role_opt()

@type role_opt() :: Rolex.DSL.role_opt()

scope()

@type scope() :: Rolex.DSL.scope()

to_opt()

@type to_opt() :: Rolex.DSL.to_opt()

Functions

deny(opts \\ [])

@spec deny([role_opt() | to_opt() | on_opt()]) :: :ok | {:error, term()}

Creates a role-denying permission from DSL options.

Returns :ok on success, or {:error, reason} otherwise.

deny!(opts \\ [])

@spec deny!([role_opt() | to_opt() | on_opt()]) :: :ok

Creates a role-denying permission from DSL options.

Returns :ok on success, or raises an exception otherwise.

deny_on(object, opts \\ [])

@spec deny_on(scope(), [role_opt() | to_opt()]) :: {:ok, scope()} | {:error, term()}

Creates a role-denying permission from DSL options, prefilling on: object.

Returns {:ok, object} on success, or {:error, reason} otherwise.

deny_on!(object, opts \\ [])

@spec deny_on!(scope(), [role_opt() | to_opt()]) :: scope()

Creates a role-denying permission from DSL options, prefilling on: object.

Returns object on success, or raises an exception otherwise.

deny_role(role, opts \\ [])

@spec deny_role(role(), [to_opt() | on_opt()]) :: {:ok, role()} | {:error, term()}

Creates a role-denying permission from DSL options, prefilling role: role.

Returns {:ok, role} on success, or {:error, reason} otherwise.

deny_role!(role, opts \\ [])

@spec deny_role!(role(), [to_opt() | on_opt()]) :: role()

Creates a role-denying permission from DSL options, prefilling role: role.

Returns role on success, or raises an exception otherwise.

deny_to(subject, opts \\ [])

@spec deny_to(scope(), [role_opt() | on_opt()]) :: {:ok, scope()} | {:error, term()}

Creates a role-denying permission from DSL options, prefilling to: subject.

Returns {:ok, subject} on success, or {:error, reason} otherwise.

deny_to!(subject, opts \\ [])

@spec deny_to!(scope(), [role_opt() | on_opt()]) :: scope()

Creates a role-denying permission from DSL options, prefilling to: subject.

Returns subject on success, or raises an exception otherwise.

grant(opts \\ [])

@spec grant([role_opt() | to_opt() | on_opt()]) :: :ok | {:error, term()}

Creates a role-granting permission from DSL options.

Returns :ok on success, or {:error, reason} otherwise.

grant!(opts \\ [])

@spec grant!([role_opt() | to_opt() | on_opt()]) :: :ok

Creates a role-granting permission from DSL options.

Returns :ok on success, or raises an exception otherwise.

grant_on(object, opts \\ [])

@spec grant_on(scope(), [role_opt() | to_opt()]) :: {:ok, scope()} | {:error, term()}

Creates a role-granting permission from DSL options, prefilling on: object.

Returns {:ok, object} on success, or {:error, reason} otherwise.

grant_on!(object, opts \\ [])

@spec grant_on!(scope(), [role_opt() | to_opt()]) :: scope()

Creates a role-granting permission from DSL options, prefilling on: object.

Returns object on success, or raises an exception otherwise.

grant_role(role, opts \\ [])

@spec grant_role(role(), [to_opt() | on_opt()]) :: {:ok, role()} | {:error, term()}

Creates a role-granting permission from DSL options, prefilling role: role.

Returns {:ok, role} on success, or {:error, reason} otherwise.

grant_role!(role, opts \\ [])

@spec grant_role!(role(), [to_opt() | on_opt()]) :: role()

Creates a role-granting permission from DSL options, prefilling role: role.

Returns role on success, or raises an exception otherwise.

grant_to(subject, opts \\ [])

@spec grant_to(scope(), [role_opt() | on_opt()]) :: {:ok, scope()} | {:error, term()}

Creates a role-granting permission from DSL options, prefilling to: subject.

Returns {:ok, subject} on success, or {:error, reason} otherwise.

grant_to!(subject, opts \\ [])

@spec grant_to!(scope(), [role_opt() | on_opt()]) :: scope()

Creates a role-granting permission from DSL options, prefilling to: subject.

Returns subject on success, or raises an exception otherwise.

multi_deny(multi, opts \\ [])

@spec multi_deny(multi(), [role_opt() | to_opt() | on_opt()]) :: multi()

Adds a multi operation to create a role-denying permission from DSL options.

Returns the updated multi.

multi_deny_on(multi, object, opts \\ [])

@spec multi_deny_on(multi(), scope(), [role_opt() | to_opt()]) :: multi()

Adds a multi operation to create a role-denying permission from DSL options, prefilling on: object.

Returns the updated multi.

multi_deny_role(multi, role, opts \\ [])

@spec multi_deny_role(multi(), role(), [to_opt() | on_opt()]) :: multi()

Adds a multi operation to create a role-denying permission from DSL options, prefilling role: role.

Returns the updated multi.

multi_deny_to(multi, subject, opts \\ [])

@spec multi_deny_to(multi(), scope(), [role_opt() | on_opt()]) :: multi()

Adds a multi operation to create a role-denying permission from DSL options, prefilling to: subject.

Returns the updated multi.

multi_grant(multi, opts \\ [])

@spec multi_grant(multi(), [role_opt() | to_opt() | on_opt()]) :: multi()

Adds a multi operation to create a role-granting permission from DSL options.

Returns the updated multi.

multi_grant_on(multi, object, opts \\ [])

@spec multi_grant_on(multi(), scope(), [role_opt() | to_opt()]) :: multi()

Adds a multi operation to create a role-granting permission from DSL options, prefilling on: object.

Returns the updated multi.

multi_grant_role(multi, role, opts \\ [])

@spec multi_grant_role(multi(), role(), [to_opt() | on_opt()]) :: multi()

Adds a multi operation to create a role-granting permission from DSL options, prefilling role: role.

Returns the updated multi.

multi_grant_to(multi, subject, opts \\ [])

@spec multi_grant_to(multi(), scope(), [role_opt() | on_opt()]) :: multi()

Adds a multi operation to create a role-granting permission from DSL options, prefilling to: subject.

Returns the updated multi.

multi_revoke(multi, opts \\ [])

@spec multi_revoke(multi(), [any_role_opt() | any_from_opt() | any_on_opt()]) ::
  multi()

Adds a multi operation to delete all permissions matching the given DSL options.

Returns the updated multi.

multi_revoke_from(multi, subject, opts \\ [])

@spec multi_revoke_from(multi(), any_scope(), [any_role_opt() | any_on_opt()]) ::
  multi()

Adds a multi operation to delete all permissions matching the given DSL options, prefilling from: subject.

Returns the updated multi.

multi_revoke_on(multi, object, opts \\ [])

@spec multi_revoke_on(multi(), any_scope(), [any_role_opt() | any_from_opt()]) ::
  multi()

Adds a multi operation to delete all permissions matching the given DSL options, prefilling on: object.

Returns the updated multi.

multi_revoke_role(multi, role, opts \\ [])

@spec multi_revoke_role(multi(), any_role(), [any_from_opt() | any_on_opt()]) ::
  multi()

Adds a multi operation to delete all permissions matching the given DSL options, prefilling role: role.

Returns the updated multi.

revoke(opts \\ [])

@spec revoke([any_role_opt() | any_from_opt() | any_on_opt()]) ::
  {:ok, non_neg_integer()} | {:error, term()}

Deletes all permissions matching the given DSL options.

Returns {:ok, <number-deleted>} on success, or {:error, changeset} otherwise.

revoke!(opts \\ [])

@spec revoke!([any_role_opt() | any_from_opt() | any_on_opt()]) :: non_neg_integer()

Deletes all permissions matching the given DSL options.

Returns the number of permissions deleted on success, or raises an exception otherwise.

revoke_from(subject, opts \\ [])

@spec revoke_from(any_scope(), [role_opt() | any_on_opt()]) ::
  {:ok, any_scope()} | {:error, term()}

Deletes all permissions matching the given DSL options, prefilling from: subject.

Returns {:ok, subject} on success, or {:error, reason} otherwise.

revoke_from!(subject, opts \\ [])

@spec revoke_from!(any_scope(), [role_opt() | any_on_opt()]) :: any_scope()

Deletes all permissions matching the given DSL options, prefilling from: subject.

Returns subject on success, or raises an exception otherwise.

revoke_on(object, opts \\ [])

@spec revoke_on(any_scope(), [role_opt() | any_from_opt()]) ::
  {:ok, any_scope()} | {:error, term()}

Deletes all permissions matching the given DSL options, prefilling on: object.

Returns {:ok, object} on success, or {:error, reason} otherwise.

revoke_on!(object, opts \\ [])

@spec revoke_on!(any_scope(), [role_opt() | any_from_opt()]) :: any_scope()

Deletes all permissions matching the given DSL options, prefilling on: object.

Returns object on success, or raises an exception otherwise.

revoke_role(role, opts \\ [])

@spec revoke_role(any_role(), [any_from_opt() | any_on_opt()]) ::
  {:ok, any_role()} | {:error, term()}

Deletes all permissions matching the given DSL options, prefilling role: role.

Returns {:ok, role} on success, or {:error, reason} otherwise.

revoke_role!(role, opts \\ [])

@spec revoke_role!(any_role(), [any_from_opt() | any_on_opt()]) :: any_role()

Deletes all permissions matching the given DSL options, prefilling role: role.

Returns role on success, or raises an exception otherwise.