Struct TSIDDatabaseID

pub struct TSIDDatabaseID<Resource: TSIDResource> { /* private fields */ }

Represents a prefixed, type-safe, resource-specific ID in your database. The resource is defined by Resource: when deserializing, that resource must be matched when reading the prefix. When serializing, that resource will be used to create the prefix.

Internally, this stores a TSID, which is actually a u64. In your database, you should probably store this u64 instead of the base32-encoded prefixed string. The numbers are time-ordered so you can sort your database with great performance.

Implementations

impl<Resource: TSIDResource> TSIDDatabaseID<Resource>

pub fn from_raw_number(number: u64) -> Self

Parse a number (e.g. from your database) into a TSID. As long as it fits into a u64, it will be a valid ID, so this can’t error.

pub fn from_integer(number: i64) -> Self

pub fn random() -> Self

Creates a new, random TSID.

pub fn to_raw_number(&self) -> u64

Returns the u64 value of the TSID stored internally. Use this to get a value you can store in your database.

pub fn into_unknown(&self) -> TSIDDatabaseID<IDUnknown>

pub fn from_str(v: &str) -> Result<TSIDDatabaseID<Resource>, Error>

Attempts to parse a string into a TSIDDatabaseID matching the prefix of the specified resource. If the string does not contain a prefix, or it contains the wrong one, an error will be returned instead.

If the resource does not require a prefix, any string is accepted, as long as it is a valid base32-encoded TSID.

Methods from Deref<Target = TSID>

pub fn number(&self) -> u64

Returns numeric representation of TSID

pub fn random_part(&self) -> u64

Trait Implementations

impl<'__expr, Resource: TSIDResource> AsExpression<BigInt> for &'__expr TSIDDatabaseID<Resource>

type Expression = Bound<BigInt, &'__expr TSIDDatabaseID<Resource>>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl<Resource: TSIDResource> AsExpression<BigInt> for TSIDDatabaseID<Resource>

type Expression = Bound<BigInt, TSIDDatabaseID<Resource>>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl<'__expr, Resource: TSIDResource> AsExpression<Nullable<BigInt>> for &'__expr TSIDDatabaseID<Resource>

type Expression = Bound<Nullable<BigInt>, &'__expr TSIDDatabaseID<Resource>>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl<Resource: TSIDResource> AsExpression<Nullable<BigInt>> for TSIDDatabaseID<Resource>

type Expression = Bound<Nullable<BigInt>, TSIDDatabaseID<Resource>>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl<Resource: Clone + TSIDResource> Clone for TSIDDatabaseID<Resource>

fn clone(&self) -> TSIDDatabaseID<Resource>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Resource: Debug + TSIDResource> Debug for TSIDDatabaseID<Resource>

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

Formats the value using the given formatter.

impl<Resource: TSIDResource> Deref for TSIDDatabaseID<Resource>

type Target = TSID

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, Resource: TSIDResource> Deserialize<'de> for TSIDDatabaseID<Resource>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Resource: TSIDResource> Display for TSIDDatabaseID<Resource>

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

Formats the value using the given formatter.

impl<Resource: TSIDResource> From<TSID> for TSIDDatabaseID<Resource>

fn from(value: TSID) -> Self

Converts to this type from the input type.

impl<Resource: TSIDResource> FromSql<BigInt, Pg> for TSIDDatabaseID<Resource>

fn from_sql(bytes: <Pg as Backend>::RawValue<'_>) -> Result<Self>

See the trait documentation.

fn from_nullable_sql( bytes: Option<<DB as Backend>::RawValue<'_>>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

A specialized variant of from_sql for handling null values.

impl<Resource: Hash + TSIDResource> Hash for TSIDDatabaseID<Resource>

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<Resource: PartialEq + TSIDResource> PartialEq for TSIDDatabaseID<Resource>

fn eq(&self, other: &TSIDDatabaseID<Resource>) -> 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<Resource: TSIDResource, __DB, __ST> Queryable<__ST, __DB> for TSIDDatabaseID<Resource>

where __DB: Backend, __ST: SingleValue, Self: FromSql<__ST, __DB>,

type Row = TSIDDatabaseID<Resource>

The Rust type you’d like to map from.

fn build(row: Self::Row) -> Result<Self>

Construct an instance of this type

impl<Resource: TSIDResource> Serialize for TSIDDatabaseID<Resource>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<Resource: TSIDResource> ToSql<BigInt, Pg> for TSIDDatabaseID<Resource>

fn to_sql<'b>(&'b self, out: &mut Output<'b, '_, Pg>) -> Result

See the trait documentation.

impl<Resource: TSIDResource, __DB> ToSql<Nullable<BigInt>, __DB> for TSIDDatabaseID<Resource>

where __DB: Backend, Self: ToSql<BigInt, __DB>,

fn to_sql<'__b>(&'__b self, out: &mut Output<'__b, '_, __DB>) -> Result

See the trait documentation.

impl<Resource: Copy + TSIDResource> Copy for TSIDDatabaseID<Resource>

impl<Resource: Eq + TSIDResource> Eq for TSIDDatabaseID<Resource>

impl<Resource: TSIDResource> StructuralPartialEq for TSIDDatabaseID<Resource>