Struct WorkspaceId 

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

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.

Implementations

impl WorkspaceId

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

Generate a new workspace ID with an entropy source. To use a SafeRand instance, use the Generatable::random method instead.

pub fn as_str(&self) -> &str

Trait Implementations

impl Clone for WorkspaceId

fn clone(&self) -> WorkspaceId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceId

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WorkspaceId

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

Formats the value using the given formatter.

impl Dummy<Faker> for WorkspaceId

fn dummy_with_rng<R>(_: &Faker, _: &mut R) -> WorkspaceId

where R: Rng + ?Sized,

Generate a dummy value for a given type using a random number generator.

fn dummy(config: &T) -> Self

Generate a dummy value for a type.

impl From<WorkspaceId> for String

fn from(value: WorkspaceId) -> String

Converts to this type from the input type.

impl FromStr for WorkspaceId

type Err = InvalidWorkspaceId

The associated error which can be returned from parsing.

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

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

impl Generatable for WorkspaceId

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

impl<'a> IntoAad<'a> for WorkspaceId

Allows WorkspaceId to be used directly as additional authenticated data (AAD) in AES-256-GCM-SIV encryption via the vitaminc crate.

This is used by the refresh token envelope to bind the workspace_id to the ciphertext so that tampering with the workspace_id causes decryption to fail. Because WorkspaceId is Copy (stack-allocated ArrayString), it can be passed by value into composite AAD tuples — e.g. (extra_aad, workspace_id) — without allocation or lifetime concerns.

fn into_aad(self) -> Aad<'a>

impl PartialEq<&str> for WorkspaceId

fn eq(&self, other: &&str) -> 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 PartialEq<String> for WorkspaceId

fn eq(&self, other: &String) -> 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 PartialEq for WorkspaceId

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

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 ToSchema for WorkspaceId

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl TryFrom<&str> for WorkspaceId

type Error = InvalidWorkspaceId

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for WorkspaceId

type Error = InvalidWorkspaceId

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for WorkspaceId

impl Eq for WorkspaceId

impl StructuralPartialEq for WorkspaceId