Trait frame_support::pallet_prelude::EnsureOrigin

pub trait EnsureOrigin<OuterOrigin> {
    type Success;

    fn try_origin(o: OuterOrigin) -> Result<Self::Success, OuterOrigin>;
    fn try_successful_origin() -> Result<OuterOrigin, ()>;

    fn ensure_origin(o: OuterOrigin) -> Result<Self::Success, BadOrigin> { ... }
}

Some sort of check on the origin is performed by this object.

Required Associated Types

type Success

A return type.

Required Methods

fn try_origin(o: OuterOrigin) -> Result<Self::Success, OuterOrigin>

Perform the origin check.

fn try_successful_origin() -> Result<OuterOrigin, ()>

Attempt to get an outer origin capable of passing try_origin check. May return Err if it is impossible.

** Should be used for benchmarking only!!! **

Provided Methods

fn ensure_origin(o: OuterOrigin) -> Result<Self::Success, BadOrigin>

Perform the origin check.

Implementors

impl<O, Original: EnsureOrigin<O>, Mutator: Morph<Original::Success>> EnsureOrigin<O> for MapSuccess<Original, Mutator>

type Success = <Mutator as Morph<<Original as EnsureOrigin<O>>::Success>>::Outcome

impl<O: Clone, Original: EnsureOrigin<O>, Mutator: TryMorph<Original::Success>> EnsureOrigin<O> for TryMapSuccess<Original, Mutator>

type Success = <Mutator as TryMorph<<Original as EnsureOrigin<O>>::Success>>::Outcome

impl<OO, Success> EnsureOrigin<OO> for NeverEnsureOrigin<Success>

type Success = Success

impl<OuterOrigin, L: EnsureOrigin<OuterOrigin>, R: EnsureOrigin<OuterOrigin>> EnsureOrigin<OuterOrigin> for EitherOfDiverse<L, R>

type Success = Either<<L as EnsureOrigin<OuterOrigin>>::Success, <R as EnsureOrigin<OuterOrigin>>::Success>

impl<OuterOrigin, L: EnsureOrigin<OuterOrigin>, R: EnsureOrigin<OuterOrigin, Success = L::Success>> EnsureOrigin<OuterOrigin> for EitherOf<L, R>

type Success = <L as EnsureOrigin<OuterOrigin>>::Success

impl<OuterOrigin, Origin, PrivilegeCmp> EnsureOrigin<OuterOrigin> for EnsureOriginEqualOrHigherPrivilege<Origin, PrivilegeCmp>where
    Origin: Get<OuterOrigin>,
    OuterOrigin: Eq,
    PrivilegeCmp: PrivilegeCmp<OuterOrigin>,

type Success = ()