Struct Purpose 

pub struct Purpose { /* private fields */ }

A purpose from aethel-core’s registry.

There is deliberately no constructor from bytes. A signing context that is not in the registry is an ad hoc context string, which is what the registry exists to prevent.

use aethel_sdk::Purpose;
let _ = Purpose { name: "MINE".into(), bytes: b"mine/v1".to_vec() };

use aethel_sdk::Purpose;
let _ = Purpose::new(b"mine/v1");

Implementations

impl Purpose

pub fn name(&self) -> &str

The registry’s name for this purpose, for example AUTH_LOGIN_V1.

pub fn as_bytes(&self) -> &[u8]

The exact bytes the component signs and verifies under.

pub fn registered() -> Result<&'static [Purpose], Error>

Every registered purpose, in the registry’s declaration order.

Read from the embedded component the first time and kept for the life of the process: the registry is fixed by the artifact.

pub fn from_name(name: &str) -> Result<Purpose, Error>

Look a purpose up by its registry name.

Returns Error::UnknownPurpose for a name that is not registered.

Trait Implementations

impl Clone for Purpose

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Purpose

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Purpose

impl PartialEq for Purpose

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Purpose