Struct ExternalId

pub struct ExternalId(/* private fields */);

An external-id used to identify external entities, that are not in the borderless-network.

These ids are version 8 uuids, where the first four bits of the uuid are set to 0xe, to indicate that it is an external-id and not another uuid based id.

Example:

ebc23cb3-f447-8107-8f93-9bfb8e1d157d

All uuid-based ids used in the borderless-ecosystem have a different prefix, based on what the id is used for. This mechanism ensures that you cannot mistake an participant-id for e.g. a contract-id and vice versa. Even if you convert the participant-id back into a uuid and the result into a contract-id, the results are different.

The implementation of the IDs is compliant with RFC9562, as we utilize standard version 8 uuids.

Implementations

impl ExternalId

pub fn into_uuid(self) -> Uuid

Converts the ID into a uuid::Uuid

pub fn from_bytes(bytes: [u8; 16]) -> ExternalId

pub fn from_slice(slice: &[u8]) -> Result<ExternalId, TryFromSliceError>

pub fn into_bytes(self) -> [u8; 16]

Returns the underlying bytes

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

Returns a reference to the underlying bytes

pub fn parse_str(s: &str) -> Result<ExternalId, Error>

Parses an ID from a &str

pub fn merge(&self, other: &ExternalId) -> [u8; 16]

Merges two IDs commutatively

Can be used to construct database keys.

pub fn merge_compact(&self, other: &ExternalId) -> u64

Merges and Compacts two IDs into a u64

Can be used to construct database keys.

pub fn compact(&self) -> u64

Compacts the current ID into a u64

Can be used to construct database keys.

Trait Implementations

impl AsRef<[u8]> for ExternalId

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8; 16]> for ExternalId

fn as_ref(&self) -> &[u8; 16]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ExternalId

fn clone(&self) -> ExternalId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExternalId

fn deserialize<D>( deserializer: D, ) -> Result<ExternalId, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ExternalId

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

Formats the value using the given formatter.

impl From<ExternalId> for Uuid

fn from(value: ExternalId) -> Uuid

Converts to this type from the input type.

impl From<Uuid> for ExternalId

fn from(value: Uuid) -> ExternalId

Converts to this type from the input type.

impl From<u128> for ExternalId

fn from(value: u128) -> ExternalId

Converts to this type from the input type.

impl FromStr for ExternalId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ExternalId, <ExternalId as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for ExternalId

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

where __H: Hasher,

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 Ord for ExternalId

fn cmp(&self, other: &ExternalId) -> 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 PartialEq for ExternalId

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

fn partial_cmp(&self, other: &ExternalId) -> 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 Serialize for ExternalId

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for ExternalId

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from( value: &[u8], ) -> Result<ExternalId, <ExternalId as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl TryFrom<&str> for ExternalId

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<ExternalId, <ExternalId as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for ExternalId

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<ExternalId, <ExternalId as TryFrom<String>>::Error>

Performs the conversion.

impl Copy for ExternalId

impl Eq for ExternalId

impl StructuralPartialEq for ExternalId