Struct ExternalId

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

A validated SCIM external identifier.

ExternalId represents an optional identifier that links a SCIM resource to an external system. It enforces validation rules at construction time, ensuring that only valid external IDs can exist in the system.

Validation Rules

• Must not be empty if provided
• Must be a valid string
• Null values are handled separately (Option<ExternalId>)

Examples

use scim_server::resource::value_objects::ExternalId;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Valid external ID
    let ext_id = ExternalId::new("701984".to_string())?;
    println!("External ID: {}", ext_id.as_str());

    // Invalid external ID - returns ValidationError
    let invalid = ExternalId::new("".to_string()); // Error
    assert!(invalid.is_err());

    Ok(())
}

Implementations

impl ExternalId

pub fn new(value: String) -> ValidationResult<Self>

Create a new ExternalId with validation.

This is the primary constructor that enforces all validation rules. Use this method when creating ExternalId instances from untrusted input.

Arguments

• value - The string value to validate and wrap

Returns

• Ok(ExternalId) - If the value is valid
• Err(ValidationError) - If the value violates validation rules

pub fn as_str(&self) -> &str

Get the string representation of the ExternalId.

pub fn into_string(self) -> String

Get the owned string value of the ExternalId.

Trait Implementations

impl Clone for ExternalId

fn clone(&self) -> ExternalId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExternalId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ExternalId

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

Formats the value using the given formatter.

impl Hash for ExternalId

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 PartialEq for ExternalId

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

fn from_schema_and_value( definition: &AttributeDefinition, value: &Value, ) -> ValidationResult<Self>

Create a value object from a JSON value and schema definition

fn can_construct_from(definition: &AttributeDefinition) -> bool

Check if this type can handle the given attribute definition

fn constructor_priority() -> u8

Get the priority for this constructor (higher = preferred) Used when multiple constructors might handle the same definition

impl Serialize for ExternalId

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 ExternalId

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> ValidationResult<Self>

Performs the conversion.

impl TryFrom<String> for ExternalId

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(value: String) -> ValidationResult<Self>

Performs the conversion.

impl ValueObject for ExternalId

fn attribute_type(&self) -> AttributeType

Get the SCIM attribute type this value object represents

fn attribute_name(&self) -> &str

Get the schema attribute name this value object corresponds to

fn to_json(&self) -> ValidationResult<Value>

Serialize the value object to JSON

fn validate_against_schema( &self, definition: &AttributeDefinition, ) -> ValidationResult<()>

Validate the value object against a schema definition

fn as_json_value(&self) -> Value

Get the raw value as a JSON Value for schema-agnostic operations

fn supports_definition(&self, definition: &AttributeDefinition) -> bool

Check if this value object supports the given attribute definition

fn clone_boxed(&self) -> Box<dyn ValueObject>

Clone the value object as a boxed trait object

fn as_any(&self) -> &dyn Any

Get type information for downcasting

impl Eq for ExternalId

impl StructuralPartialEq for ExternalId