Struct id30::Id30

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

An implementation of the Id30 encoding scheme as documented at the crate root.

This type holds a 30 bit integer as a 32 bit integer, of which the two most significant bits are always zero. The type has the same representation as u32. Debug-formatting includes both the Id30 encoding and the integer representation.

Ordering, as implemented for the PartialOrd and Ord traits, orders by numerical value of the underlying integer. This is the same order as the lexicographical ordering of the string representation.

There are many ways to create instances of Id30:

• Via the TryFrom trait from either a u32 or an i32:

  let id: Id30 = 1234.try_into().expect("1234 is in range");
  assert_eq!(Id30::try_from(1 << 31), Err(id30::OutOfRangeError));

• Parsing, via the FromStr trait:

  let id: id30::Id30 = "hrga2q".parse().unwrap();

  Tip: Parse to the Id30Parse type if you need to know whether the text representation is canonical or alternate.
• With feature rand, via the Distribution trait:

  use rand::{distributions::Standard, prelude::*};
  let mut rng = rand::thread_rng();
  
  let id: Id30 = rng.gen();
  let ids: Vec<Id30> = Standard.sample_iter(rng).take(10).collect();

• With feature serde, via deserialization
• With feature diesel, as output from queries

An Id30 can be converted directly to u32 and i32 via the From trait:

let id: Id30 = 1234.try_into().unwrap();
assert_eq!(u32::from(id), 1234);

To generate the text representation:

• format an Id30 value via the Display trait:

  let id: id30::Id30 = "j9yceq".parse().unwrap();
  assert_eq!(&id.to_string(), "j9yceq");
  assert_eq!(&format!("/path/to/{id}"), "/path/to/j9yceq");

• or, with feature serde, via serialization

Integrations with other crates

• crate rand via feature rand08 (alias rand):

  Id30 implements Distribution, enabling generation of random Id30 values.

• crate serde via feature serde1 (alias serde):

  Id30 implements Serialize and Deserialize, enabling serialization and deserialization of Id30 values as text through serde.

• crate diesel via feature diesel2 (alias diesel):

  Id30 implements FromSql and Queryable, enabling deserialization of integers from the database as Id30 values, and ToSql, enabling serialization of Id30 values as integers in the database. Additionally, AsExpression is implemented, enabling the usage of Id30 values in diesel query builder expressions.

Trait Implementations

impl<'expr> AsExpression<Integer> for &'expr Id30

type Expression = Bound<Integer, &'expr Id30>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsExpression<Integer> for Id30

type Expression = Bound<Integer, Id30>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl<'expr> AsExpression<Nullable<Integer>> for &'expr Id30

type Expression = Bound<Nullable<Integer>, &'expr Id30>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsExpression<Nullable<Integer>> for Id30

type Expression = Bound<Nullable<Integer>, Id30>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl Clone for Id30

fn clone(&self) -> Id30

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id30

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Id30

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Id30

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

Formats the value using the given formatter.

impl Distribution<Id30> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Id30

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl From<Id30> for i32

fn from(value: Id30) -> Self

Converts to this type from the input type.

impl From<Id30> for u32

fn from(value: Id30) -> Self

Converts to this type from the input type.

impl<DB> FromSql<Integer, DB> for Id30

where DB: Backend, i32: FromSql<Integer, DB>,

fn from_sql(bytes: DB::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 FromStr for Id30

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Id30

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 Id30

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

Restrict a value to a certain interval.

impl PartialEq for Id30

fn eq(&self, other: &Id30) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Id30

fn partial_cmp(&self, other: &Id30) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<__ST, __DB> Queryable<__ST, __DB> for Id30

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

type Row = Id30

The Rust type you’d like to map from.

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

Construct an instance of this type

impl Serialize for Id30

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<DB> ToSql<Integer, DB> for Id30

where DB: Backend, i32: ToSql<Integer, DB>,

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

See the trait documentation.

impl<__DB> ToSql<Nullable<Integer>, __DB> for Id30

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

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

See the trait documentation.

impl TryFrom<i32> for Id30

type Error = OutOfRangeError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for Id30

type Error = OutOfRangeError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Id30

impl Eq for Id30

impl StructuralPartialEq for Id30