# `Ash.Can`
[🔗](https://github.com/ash-project/ash/blob/v3.23.1/lib/ash/can.ex#L5)

Contains the Ash.can function logic.

# `subject`

```elixir
@type subject() ::
  Ash.Query.t()
  | Ash.Changeset.t()
  | Ash.ActionInput.t()
  | {Ash.Resource.t(), atom() | Ash.Resource.Actions.action()}
  | {Ash.Resource.t(), atom() | Ash.Resource.Actions.action(), input :: map()}
  | {Ash.Resource.record(), atom() | Ash.Resource.Actions.action()}
  | {Ash.Resource.record(), atom() | Ash.Resource.Actions.action(),
     input :: map()}
```

# `can`

```elixir
@spec can(subject(), Ash.Domain.t(), Ash.actor() | Ash.Scope.t(), Keyword.t()) ::
  {:ok, boolean() | :maybe}
  | {:ok, boolean(), term()}
  | {:ok, boolean(), Ash.Changeset.t(), Ash.Query.t()}
  | {:error, Ash.Error.t()}
```

Returns a an ok tuple if the actor can perform the action, query, or changeset,
an error tuple if an error happens, and a ok tuple with maybe if maybe is set to true
or not set.

You should prefer to use `Ash.can/3` over this module, directly.

Note: `is_maybe` is set to `true`, if not set.

# `can?`

```elixir
@spec can?(subject(), Ash.Domain.t(), Ash.Resource.record(), Keyword.t()) ::
  boolean() | no_return()
```

Returns whether an actor can perform an action, query, or changeset.

You should prefer to use `Ash.can?/3` over this module, directly.

Can raise an exception if return_forbidden_error is truthy in opts or there's an error.

---

*Consult [api-reference.md](api-reference.md) for complete listing*