Struct PossiblyAuthorisedEntry 

pub struct PossiblyAuthorisedEntry<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD, AT> {
    pub entry: Entry<MCL, MCC, MPL, N, S, PD>,
    pub authorisation_token: AT,
}

An entry, together with an authorisation token that may or may not authorise the entry.

use willow_data_model::prelude::*;
use willow_data_model::test_parameters::*;

let entry = Entry::builder()
    .namespace_id(Family)
    .subspace_id(Alfie)
    .path(Path::<4, 4, 4>::new())
    .timestamp(12345)
    .payload_digest(Spades)
    .payload_length(2)
    .build().unwrap();

let pae = PossiblyAuthorisedEntry {
    entry: entry.clone(),
    authorisation_token: TestSubspaceSignature::new_for_entry(&entry, &AlfieSecret).unwrap(),
};
assert!(pae.into_authorised_entry().is_ok());

Specification

Fields

entry: Entry<MCL, MCC, MPL, N, S, PD>

The entry.

authorisation_token: AT

The authorisation token, which may or may not authorise the entry.

Implementations

impl<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD, AT> PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

pub fn into_authorised_entry( self, ) -> Result<AuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>, Self>

where AT: AuthorisationToken<MCL, MCC, MPL, N, S, PD>,

Checks whether self.authorisation_token authorise self.entry. If so, converts self into an AuthorisedEntry, otherwise returns Err(self).

use willow_data_model::prelude::*;
use willow_data_model::test_parameters::*;

let entry = Entry::builder()
    .namespace_id(Family)
    .subspace_id(Alfie)
    .path(Path::<4, 4, 4>::new())
    .timestamp(12345)
    .payload_digest(Spades)
    .payload_length(2)
    .build().unwrap();

let pae1 = PossiblyAuthorisedEntry {
    entry: entry.clone(),
    authorisation_token: TestSubspaceSignature::new_for_entry(&entry, &AlfieSecret).unwrap(),
};
assert!(pae1.into_authorised_entry().is_ok());

let pae2 = PossiblyAuthorisedEntry {
    entry: entry.clone(),
    authorisation_token: BettySignature,
};
assert!(pae2.into_authorised_entry().is_err());

pub unsafe fn into_authorised_entry_unchecked( self, ) -> AuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

Converts self into an AuthorisedEntry, without checking if self.authorisation_token authorise self.entry.

use willow_data_model::prelude::*;
use willow_data_model::test_parameters::*;

let entry = Entry::builder()
    .namespace_id(Family)
    .subspace_id(Alfie)
    .path(Path::<4, 4, 4>::new())
    .timestamp(12345)
    .payload_digest(Spades)
    .payload_length(2)
    .build().unwrap();

let pae = PossiblyAuthorisedEntry {
    entry: entry.clone(),
    authorisation_token: TestSubspaceSignature::new_for_entry(&entry, &AlfieSecret).unwrap(),
};
let authed = unsafe { pae.into_authorised_entry_unchecked() };
assert_eq!(authed.as_entry(), &entry);
assert_eq!(authed.as_authorisation_token(), &AlfieSignature);

Safety

Undefined behaviour may occur if self.authorisation_token.does_authorise(&self.entry) is false. If it returns true, this method is safe to call.

Trait Implementations

impl<'arbitrary, const MCL: usize, const MCC: usize, const MPL: usize, N: Arbitrary<'arbitrary>, S: Arbitrary<'arbitrary>, PD: Arbitrary<'arbitrary>, AT: Arbitrary<'arbitrary>> Arbitrary<'arbitrary> for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N: Clone, S: Clone, PD: Clone, AT: Clone> Clone for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

fn clone(&self) -> PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD, AT> Coordinatelike<MCL, MCC, MPL, S> for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

fn wdm_timestamp(&self) -> Timestamp

Returns the timestamp of self.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N: Debug, S: Debug, PD: Debug, AT: Debug> Debug for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

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

Formats the value using the given formatter.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD, AT> Entrylike<MCL, MCC, MPL, N, S, PD> for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

fn wdm_payload_length(&self) -> u64

Returns the payload_length of self.

fn wdm_payload_digest(&self) -> &PD

Returns the payload_digest of self.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N: Hash, S: Hash, PD: Hash, AT: Hash> Hash for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD, AT> Keylike<MCL, MCC, MPL, S> for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

fn wdm_subspace_id(&self) -> &S

Returns the subspace_id of self.

fn wdm_path(&self) -> &Path<MCL, MCC, MPL>

Returns the path of self.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD, AT> Namespaced<N> for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

fn wdm_namespace_id(&self) -> &N

Returns the namespace id of self.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N: Ord, S: Ord, PD: Ord, AT: Ord> Ord for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

fn cmp( &self, other: &PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>, ) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N: PartialEq, S: PartialEq, PD: PartialEq, AT: PartialEq> PartialEq for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

fn eq( &self, other: &PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>, ) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N: PartialOrd, S: PartialOrd, PD: PartialOrd, AT: PartialOrd> PartialOrd for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

fn partial_cmp( &self, other: &PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N: Eq, S: Eq, PD: Eq, AT: Eq> Eq for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>

impl<const MCL: usize, const MCC: usize, const MPL: usize, N, S, PD, AT> StructuralPartialEq for PossiblyAuthorisedEntry<MCL, MCC, MPL, N, S, PD, AT>