Struct OrgId 

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

A UUID v4 tenant identifier, typically propagated via the X-Org-Id HTTP header.

Use OrgId::generate to create a fresh identifier, or FromStr / TryFrom to parse one from an incoming header.

The Display implementation produces the canonical hyphenated UUID string (e.g. 550e8400-e29b-41d4-a716-446655440000).

Implementations

impl OrgId

pub const fn new(id: Uuid) -> Self

Wrap an existing uuid::Uuid as an OrgId.

use api_bones::org_id::OrgId;

let id = OrgId::new(uuid::Uuid::nil());
assert_eq!(id.to_string(), "00000000-0000-0000-0000-000000000000");

pub fn generate() -> Self

Generate a new random OrgId (UUID v4).

use api_bones::org_id::OrgId;

let id = OrgId::generate();
assert_eq!(id.inner().get_version_num(), 4);

pub fn inner(&self) -> Uuid

Return the inner uuid::Uuid.

use api_bones::org_id::OrgId;

let uuid = uuid::Uuid::nil();
let id = OrgId::new(uuid);
assert_eq!(id.inner(), uuid);

Trait Implementations

impl Clone for OrgId

fn clone(&self) -> OrgId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrgId

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

Formats the value using the given formatter.

impl Default for OrgId

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrgId

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for OrgId

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

Formats the value using the given formatter.

impl From<OrgId> for Uuid

fn from(o: OrgId) -> Self

Converts to this type from the input type.

impl From<Uuid> for OrgId

fn from(id: Uuid) -> Self

Converts to this type from the input type.

impl FromStr for OrgId

type Err = OrgIdError

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 OrgId

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 HeaderId for OrgId

Available on crate feature std only.

const HEADER_NAME: &'static str = "X-Org-Id"

The canonical HTTP header name for this type.

fn as_str(&self) -> Cow<'_, str>

Return the string representation of this header value.

impl PartialEq for OrgId

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for OrgId

type Error = OrgIdError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for OrgId

type Error = OrgIdError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for OrgId

impl Eq for OrgId

impl StructuralPartialEq for OrgId