Enum ReceiverRequirement

pub enum ReceiverRequirement {
    Require,
    Allow,
    Omit,
}

An enumeration of the ways in which a receiver may be requested to be present in a generated UnifiedAddress.

Variants

Require

A receiver of the associated type is required to be present in the generated [UnifiedAddress], and if it is not possible to generate a receiver of this type, the address generation method should return an error. When calling Self::intersect, this variant will be preferred over ReceiverRequirement::Allow.

Allow

The associated receiver should be included, if a corresponding item exists in the IVK from which the address is being derived and derivation of the receiver succeeds at the given diversifier index.

Omit

No receiver of the associated type may be included in the generated UnifiedAddress under any circumstances. When calling Self::intersect, this variant will be preferred over ReceiverRequirement::Allow.

Implementations

impl ReceiverRequirement

pub fn intersect( self, other: ReceiverRequirement, ) -> Result<ReceiverRequirement, ()>

Return the intersection of two requirements that chooses the stronger requirement, if one exists. ReceiverRequirement::Require and ReceiverRequirement::Omit are incompatible; attempting an intersection between these will return an error.

Trait Implementations

impl Clone for ReceiverRequirement

fn clone(&self) -> ReceiverRequirement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiverRequirement

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

Formats the value using the given formatter.

impl PartialEq for ReceiverRequirement

fn eq(&self, other: &ReceiverRequirement) -> 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 Copy for ReceiverRequirement

impl Eq for ReceiverRequirement

impl StructuralPartialEq for ReceiverRequirement