Struct Identity 

pub struct Identity { /* private fields */ }

An Identity for something interacting with the database.

An Identity is a 256-bit unsigned integer. These are encoded in various ways.

• In JSON, an Identity is represented as a hexadecimal number wrapped in a string, "0x[64 hex characters]".
• In BSATN, an Identity is represented as a LITTLE-ENDIAN number 32 bytes long.
• In memory, an Identity is stored as a 256-bit number with the endianness of the host system.

If you are manually converting a hexadecimal string to a byte array like so:

"0xb0b1b2..."
->
[0xb0, 0xb1, 0xb2, ...]

Make sure you call Identity::from_be_byte_array and NOT Identity::from_byte_array. The standard way of writing hexadecimal numbers follows a big-endian convention, if you index the characters in written text in increasing order from left to right.

Implementations

impl Identity

pub const ZERO: Identity

The 0x0 Identity

pub const ONE: Identity

The 0x1 Identity

pub const fn from_byte_array(bytes: [u8; 32]) -> Identity

Create an Identity from a LITTLE-ENDIAN byte array.

If you are parsing an Identity from a string, you probably want from_be_byte_array instead.

pub const fn from_be_byte_array(bytes: [u8; 32]) -> Identity

Create an Identity from a BIG-ENDIAN byte array.

This method is the correct choice if you have converted the bytes of a hexadecimal-formatted Identity to a byte array in the following way:

"0xb0b1b2..."
->
[0xb0, 0xb1, 0xb2, ...]

pub const fn from_u256(__identity__: U256) -> Identity

Converts __identity__: u256 to Identity.

pub const fn to_u256(&self) -> U256

Converts this identity to an u256.

pub fn from_claims(issuer: &str, subject: &str) -> Identity

Derives an identity from a JWT issuer and a subject.

pub fn to_byte_array(&self) -> [u8; 32]

Returns this Identity as a byte array.

pub fn to_be_byte_array(&self) -> [u8; 32]

Convert this Identity to a BIG-ENDIAN byte array.

pub fn to_hex(&self) -> HexString<32>

Convert this Identity to a hexadecimal string.

pub fn abbreviate(&self) -> [u8; 8]

Extract the first 8 bytes of this Identity as if it was stored in BIG-ENDIAN format. (That is, the most significant bytes.)

pub fn to_abbreviated_hex(&self) -> HexString<8>

Extract the first 16 characters of this Identity’s hexadecimal representation.

pub fn from_hex(hex: impl AsRef<[u8]>) -> Result<Identity, FromHexError>

Trait Implementations

impl AsPrometheusLabel for Identity

Available on crate feature metrics_impls only.

fn as_prometheus_str(&self) -> impl AsRef<str>

impl Clone for Identity

fn clone(&self) -> Identity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identity

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

Formats the value using the given formatter.

impl Default for Identity

fn default() -> Identity

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Identity

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

where D: Deserializer<'de>,

Deserialize this value from the given deserializer.

impl<'de> Deserialize<'de> for Identity

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Identity

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

Formats the value using the given formatter.

impl FilterableValue for &Identity

type Column = Identity

impl FilterableValue for Identity

type Column = Identity

impl FromHex for Identity

type Error = FromHexError

fn from_hex<T>(hex: T) -> Result<Identity, <Identity as FromHex>::Error>

where T: AsRef<[u8]>,

Creates an instance of type Self from the given hex string, or fails with a custom error type.

impl FromStr for Identity

type Err = <Identity as FromHex>::Error

The associated error which can be returned from parsing.

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

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

impl GroundSpacetimeType for Identity

fn get_type() -> AlgebraicType

Returns the AlgebraicType representation of Self.

impl Hash for Identity

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 Identity

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

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

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

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

where S: Serializer,

Serialize self in the data format of S using the provided serializer.

impl Serialize for Identity

Available on crate feature serde only.

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 SpacetimeType for Identity

fn make_type<S>(_ts: &mut S) -> AlgebraicType

where S: TypespaceBuilder,

Returns an AlgebraicType representing the type for Self in SATS and in the typing context in typespace. This is used by the automatic type registration system in Rust modules.

impl Copy for Identity

impl Eq for Identity

impl StructuralPartialEq for Identity