Struct RoutingParameters 

pub struct RoutingParameters { /* private fields */ }

Parameters that define how a sender should route a note to the AddressId in an Address.

Implementations

impl RoutingParameters

pub fn new(interface: AddressInterface) -> RoutingParameters

Creates new RoutingParameters from an AddressInterface and all other parameters initialized to None.

pub fn with_note_tag_len( self, note_tag_len: u8, ) -> Result<RoutingParameters, AddressError>

Sets the note tag length routing parameter.

The tag length determines how many bits of the address ID are encoded into NoteTags of notes targeted to this address. This lets the receiver choose their level of privacy. A higher tag length makes the address ID more uniquely identifiable and reduces privacy, while a shorter length increases privacy at the cost of matching more notes published onchain.

Errors

Returns an error if:

• The tag length exceeds the maximum of NoteTag::MAX_LOCAL_TAG_LENGTH and NoteTag::DEFAULT_NETWORK_TAG_LENGTH.

pub fn note_tag_len(&self) -> Option<u8>

Returns the note tag length preference.

This is guaranteed to be in range 0..=30 (e.g. the maximum of NoteTag::MAX_LOCAL_TAG_LENGTH and NoteTag::DEFAULT_NETWORK_TAG_LENGTH).

pub fn interface(&self) -> AddressInterface

Returns the AddressInterface of the account to which the address points.

pub fn encryption_key(&self) -> Option<&SealingKey>

Returns the public encryption key.

pub fn with_encryption_key(self, key: SealingKey) -> RoutingParameters

Sets the encryption key routing parameter.

This allows senders to encrypt note payloads using sealed box encryption for the recipient of this address.

Trait Implementations

impl Clone for RoutingParameters

fn clone(&self) -> RoutingParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoutingParameters

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

Formats the value using the given formatter.

impl Deserializable for RoutingParameters

fn read_from<R>( source: &mut R, ) -> Result<RoutingParameters, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for RoutingParameters

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

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for RoutingParameters

impl StructuralPartialEq for RoutingParameters