Struct ConnectionId 

pub struct ConnectionId { /* private fields */ }

A unique identifier for a client connection to a SpacetimeDB database.

This is a special type.

A ConnectionId is a 128-bit unsigned integer. This can be serialized in various ways.

• In JSON, an ConnectionId is represented as a BARE DECIMAL number. This requires some care when deserializing; see https://stackoverflow.com/questions/69644298/how-to-make-json-parse-to-treat-all-the-numbers-as-bigint
• In BSATN, a ConnectionId is represented as a LITTLE-ENDIAN number 16 bytes long.
• In memory, a ConnectionId is stored as a 128-bit number with the endianness of the host system.

Implementations

impl ConnectionId

pub const ZERO: Self

pub const fn from_u128(__connection_id__: u128) -> Self

pub const fn to_u128(&self) -> u128

pub const fn from_le_byte_array(arr: [u8; 16]) -> Self

Create an ConnectionId from a little-endian byte array.

If you are parsing an ConnectionId from a string, you probably want Self::from_be_byte_array instead. But if you need to convert a hexadecimal string to a ConnectionId, just use Self::from_hex.

pub const fn from_be_byte_array(arr: [u8; 16]) -> Self

Create an ConnectionId from a big-endian byte array.

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

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

But if you need to convert a hexadecimal string to a ConnectionId, just use Self::from_hex.

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

Convert a ConnectionId to a little-endian byte array.

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

Convert a ConnectionId to a big-endian byte array.

This is a format suitable for printing as a hexadecimal string. But if you need to convert a ConnectionId to a hexadecimal string, just use Self::to_hex.

pub fn from_hex(hex: &str) -> Result<Self, Error>

Parse a hexadecimal string into a ConnectionId.

pub fn to_hex(self) -> HexString<16>

Convert this ConnectionId to a hexadecimal string.

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

Extract the first 8 bytes of this ConnectionId 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 ConnectionId’s hexadecimal representation.

pub fn from_be_slice(slice: impl AsRef<[u8]>) -> Self

Create an ConnectionId from a slice, assumed to be in big-endian format.

pub fn to_ipv6(self) -> Ipv6Addr

pub fn to_ipv6_string(self) -> String

pub fn none_if_zero(self) -> Option<Self>

Trait Implementations

impl AsPrometheusLabel for ConnectionId

Available on crate feature metrics_impls only.

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

impl Clone for ConnectionId

fn clone(&self) -> ConnectionId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConnectionId

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

Deserialize this value from the given deserializer.

impl<'de> Deserialize<'de> for ConnectionId

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ConnectionId

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

Formats the value using the given formatter.

impl FilterableValue for &ConnectionId

type Column = ConnectionId

impl FilterableValue for ConnectionId

type Column = ConnectionId

impl From<ConnectionId> for AlgebraicValue

fn from(value: ConnectionId) -> Self

Converts to this type from the input type.

impl From<ConnectionId> for ConnectionIdForUrl

fn from(addr: ConnectionId) -> Self

Converts to this type from the input type.

impl From<ConnectionIdForUrl> for ConnectionId

fn from(addr: ConnectionIdForUrl) -> Self

Converts to this type from the input type.

impl From<u128> for ConnectionId

fn from(value: u128) -> Self

Converts to this type from the input type.

impl GroundSpacetimeType for ConnectionId

fn get_type() -> AlgebraicType

Returns the AlgebraicType representation of Self.

impl Hash for ConnectionId

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

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

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

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

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

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

impl Serialize for ConnectionId

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl SpacetimeType for ConnectionId

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

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 ConnectionId

impl Eq for ConnectionId

impl StructuralPartialEq for ConnectionId