Struct WorkspaceId

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

Expand description

A unique identifier for a workspace. Workspace IDs are 10-byte random strings formatted in base32.

Internally, the workspace ID is stored as an ArrayString with a maximum length of 20 characters. This means that values work entirely on the stack and implement the Copy trait.

§Example

use cts_common::WorkspaceId;

let workspace_id = WorkspaceId::generate().unwrap();
println!("Workspace ID: {}", workspace_id);

A WorkspaceId can be converted from a string but will fail if the string is not a valid workspace ID.

use cts_common::WorkspaceId;
let workspace_id = WorkspaceId::try_from("JBSWY3DPEHPK3PXP").unwrap();

// This will fail because the string is not a valid workspace ID
let workspace_id = WorkspaceId::try_from("invalid-id").unwrap_err();

§Comparison

Workspace IDs can be compared to strings.

use cts_common::WorkspaceId;
let workspace_id = WorkspaceId::try_from("E4UMRN47WJNSMAKR").unwrap();
assert_eq!(workspace_id, "E4UMRN47WJNSMAKR");

§Use with Diesel

When the server feature is enabled, WorkspaceId can be used with Diesel in models and queries. The underlying data type is a Text column in the database.

Struct WorkspaceIdCopy item path

§Example

§Comparison

§Use with Diesel

Implementations§

impl WorkspaceId

pub fn generate() -> Result<WorkspaceId, WorkspaceIdGenerationError>

pub fn as_str(&self) -> &str

Trait Implementations§

impl<'__expr> AsExpression<Nullable<Text>> for &'__expr WorkspaceId

type Expression = Bound<Nullable<Text>, &'__expr WorkspaceId>

fn as_expression( self, ) -> <&'__expr WorkspaceId as AsExpression<Nullable<Text>>>::Expression

impl AsExpression<Nullable<Text>> for WorkspaceId

type Expression = Bound<Nullable<Text>, WorkspaceId>

fn as_expression( self, ) -> <WorkspaceId as AsExpression<Nullable<Text>>>::Expression

impl<'__expr> AsExpression<Text> for &'__expr WorkspaceId

type Expression = Bound<Text, &'__expr WorkspaceId>

fn as_expression( self, ) -> <&'__expr WorkspaceId as AsExpression<Text>>::Expression

impl AsExpression<Text> for WorkspaceId

type Expression = Bound<Text, WorkspaceId>

fn as_expression(self) -> <WorkspaceId as AsExpression<Text>>::Expression

impl Clone for WorkspaceId

fn clone(&self) -> WorkspaceId

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

impl Debug for WorkspaceId

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

impl<'de> Deserialize<'de> for WorkspaceId

fn deserialize<__D>( __deserializer: __D, ) -> Result<WorkspaceId, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

impl Display for WorkspaceId

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

impl Dummy<Faker> for WorkspaceId

fn dummy_with_rng<R>(_: &Faker, _: &mut R) -> WorkspaceIdwhere R: Rng + ?Sized,

fn dummy(config: &T) -> Self

impl From<WorkspaceId> for String

fn from(value: WorkspaceId) -> String

impl<DB> FromSql<Text, DB> for WorkspaceIdwhere DB: Backend, String: FromSql<Text, DB>,

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

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

impl FromStr for WorkspaceId

type Err = InvalidWorkspaceId

fn from_str(value: &str) -> Result<WorkspaceId, <WorkspaceId as FromStr>::Err>

impl Generatable for WorkspaceId

fn random(rng: &mut SafeRand) -> Result<WorkspaceId, RandomError>

impl PartialEq<&str> for WorkspaceId

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

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

impl PartialEq<String> for WorkspaceId

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

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

impl PartialEq for WorkspaceId

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

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

impl<__DB, __ST> Queryable<__ST, __DB> for WorkspaceIdwhere __DB: Backend, __ST: SingleValue, WorkspaceId: FromSql<__ST, __DB>,

type Row = WorkspaceId

fn build(row: WorkspaceId) -> Result<WorkspaceId, Box<dyn Error + Sync + Send>>

impl Serialize for WorkspaceId

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

impl<__DB> ToSql<Nullable<Text>, __DB> for WorkspaceIdwhere __DB: Backend, WorkspaceId: ToSql<Text, __DB>,

fn to_sql<'__b>( &'__b self, out: &mut Output<'__b, '_, __DB>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl<DB> ToSql<Text, DB> for WorkspaceIdwhere DB: Backend, str: ToSql<Text, DB>,

fn to_sql<'b>( &'b self, out: &mut Output<'b, '_, DB>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl TryFrom<&str> for WorkspaceId

type Error = InvalidWorkspaceId

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

impl TryFrom<String> for WorkspaceId

type Error = InvalidWorkspaceId

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

impl TryInto<HeaderValue> for WorkspaceId

type Error = InvalidHeaderValue

fn try_into( self, ) -> Result<HeaderValue, <WorkspaceId as TryInto<HeaderValue>>::Error>

impl Copy for WorkspaceId

impl Eq for WorkspaceId

impl StructuralPartialEq for WorkspaceId

Auto Trait Implementations§

impl Freeze for WorkspaceId

impl RefUnwindSafe for WorkspaceId

impl Send for WorkspaceId

impl Sync for WorkspaceId

impl Unpin for WorkspaceId

impl UnwindSafe for WorkspaceId

Struct WorkspaceId

impl<'expr> AsExpression<Nullable<Text>> for &'expr WorkspaceId

impl<'expr> AsExpression<Text> for &'expr WorkspaceId

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

fn dummy_with_rng<R>(_: &Faker, _: &mut R) -> WorkspaceId
where R: Rng + ?Sized,

impl<DB> FromSql<Text, DB> for WorkspaceId
where DB: Backend, String: FromSql<Text, DB>,

impl<DB, ST> Queryable<ST, DB> for WorkspaceId
where DB: Backend, ST: SingleValue, WorkspaceId: FromSql<ST, DB>,

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

impl<DB> ToSql<Nullable<Text>, DB> for WorkspaceId
where DB: Backend, WorkspaceId: ToSql<Text, DB>,

fn to_sql<'b>( &'b self, out: &mut Output<'__b, '_, __DB>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl<DB> ToSql<Text, DB> for WorkspaceId
where DB: Backend, str: ToSql<Text, DB>,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn fake<U>(&self) -> U
where Self: FakeBase<U>,

fn fake_with_rng<U, R>(&self, rng: &mut R) -> U
where R: Rng + ?Sized, Self: FakeBase<U>,

fn fake<U>(&self) -> U
where Self: FakeBase<U>,

fn fake_with_rng<U, R>(&self, rng: &mut R) -> U
where R: Rng + ?Sized, Self: FakeBase<U>,

impl<T> FromRef<T> for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

fn into_sql<T>(self) -> Self::Expression
where Self: Sized + AsExpression<T>, T: SqlType + TypedExpressionType,

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression
where &'a Self: AsExpression<T>, T: SqlType + TypedExpressionType,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,