Struct ResourceId

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

A validated SCIM resource identifier.

ResourceId represents a unique identifier for a SCIM resource. It enforces validation rules at construction time, ensuring that only valid resource IDs can exist in the system.

Validation Rules

• Must not be empty
• Must be a valid string
• Additional format rules may be added in the future

Examples

use scim_server::resource::value_objects::ResourceId;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Valid resource ID
    let id = ResourceId::new("2819c223-7f76-453a-919d-413861904646".to_string())?;
    println!("Resource ID: {}", id.as_str());

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

    Ok(())
}

Implementations

impl ResourceId

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

Create a new ResourceId with validation.

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

Arguments

• value - The string value to validate and wrap

Returns

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

Examples

use scim_server::resource::value_objects::ResourceId;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let id = ResourceId::new("user-123".to_string())?;
    let empty_id = ResourceId::new("".to_string()); // Error
    assert!(empty_id.is_err());
    Ok(())
}

pub fn as_str(&self) -> &str

Get the string representation of the ResourceId.

Returns a reference to the underlying string value. This is safe because the value is guaranteed to be valid by construction.

Examples

use scim_server::resource::value_objects::ResourceId;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let id = ResourceId::new("test-id".to_string())?;
    assert_eq!(id.as_str(), "test-id");
    Ok(())
}

pub fn into_string(self) -> String

Get the owned string value of the ResourceId.

Consumes the ResourceId and returns the underlying string. Use this when you need to transfer ownership of the string value.

Examples

use scim_server::resource::value_objects::ResourceId;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let id = ResourceId::new("test-id".to_string())?;
    let owned_string = id.into_string();
    assert_eq!(owned_string, "test-id");
    Ok(())
}

Trait Implementations

impl Clone for ResourceId

fn clone(&self) -> ResourceId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ResourceId

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

Formats the value using the given formatter.

impl Hash for ResourceId

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 ResourceId

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

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 ResourceId

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 ResourceId

Convert from &str to ResourceId with validation.

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 ResourceId

Convert from String to ResourceId with validation.

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 ResourceId

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 ResourceId

impl StructuralPartialEq for ResourceId