Trait frame_support::traits::EnsureOrigin
source · pub trait EnsureOrigin<OuterOrigin> {
type Success;
fn try_origin(o: OuterOrigin) -> Result<Self::Success, OuterOrigin>;
fn ensure_origin(o: OuterOrigin) -> Result<Self::Success, BadOrigin> { ... }
fn successful_origin() -> OuterOrigin { ... }
fn try_successful_origin() -> Result<OuterOrigin, ()> { ... }
}
Expand description
Some sort of check on the origin is performed by this object.
Required Associated Types§
Required Methods§
sourcefn try_origin(o: OuterOrigin) -> Result<Self::Success, OuterOrigin>
fn try_origin(o: OuterOrigin) -> Result<Self::Success, OuterOrigin>
Perform the origin check.
Provided Methods§
sourcefn ensure_origin(o: OuterOrigin) -> Result<Self::Success, BadOrigin>
fn ensure_origin(o: OuterOrigin) -> Result<Self::Success, BadOrigin>
Perform the origin check.
sourcefn successful_origin() -> OuterOrigin
fn successful_origin() -> OuterOrigin
Returns an outer origin capable of passing try_origin
check.
NOTE: This should generally NOT be reimplemented. Instead implement
try_successful_origin
.
** Should be used for benchmarking only!!! **
sourcefn try_successful_origin() -> Result<OuterOrigin, ()>
fn try_successful_origin() -> Result<OuterOrigin, ()>
Attept to get an outer origin capable of passing try_origin
check. May return Err
if it
is impossible. Default implementation just uses successful_origin()
.
** Should be used for benchmarking only!!! **