Skip to content

Conform LossLessStringConvertible for UUID #1303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conform LossLessStringConvertible for UUID #1303

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
061512b
Impelment LossLessStringConvertible for UUID
jevonmao May 20, 2025
fef8d59
Add availability annotation
jevonmao May 24, 2025
9fae1cb
Add foundationpreview 6.2
jevonmao May 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion Sources/FoundationEssentials/UUID.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public typealias uuid_string_t = (Int8, Int8, Int8, Int8, Int8, Int8, Int8, Int8

/// Represents UUID strings, which can be used to uniquely identify types, interfaces, and other items.
@available(macOS 10.8, iOS 6.0, tvOS 9.0, watchOS 2.0, *)
public struct UUID : Hashable, Equatable, CustomStringConvertible, Sendable {
public struct UUID : Hashable, Equatable, CustomStringConvertible, Sendable, LosslessStringConvertible {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new conformance and the new init need to have the new availability annotation.

public private(set) var uuid: uuid_t = (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)

/* Create a new UUID with RFC 4122 version 4 random bytes */
Expand Down Expand Up @@ -57,6 +57,11 @@ public struct UUID : Hashable, Equatable, CustomStringConvertible, Sendable {
public init(uuid: uuid_t) {
self.uuid = uuid
}

/// LosslessStringConvertible initializer
public init?(_ description: String) {
self.init(uuidString: description)
}

/// Returns a string created from the UUID, such as "E621E1F8-C36C-495A-93FC-0C247A3E6E5F"
public var uuidString: String {
Expand Down
15 changes: 15 additions & 0 deletions Tests/FoundationEssentialsTests/UUIDTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,19 @@ final class UUIDTests : XCTestCase {
XCTAssertFalse(uuid2 > uuid1)
XCTAssertTrue(uuid2 == uuid1)
}

func test_UUIDLosslessStringConvertible() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually we just recently switched to use swift-testing two weeks ago. Do you mind rebasing main and updating this test to swift-testing?

let originalString = "E621E1F8-C36C-495A-93FC-0C247A3E6E5F"
let uuidFromString = UUID(originalString)
XCTAssertNotNil(uuidFromString, "UUID must be constructible from valid UUID string via LosslessStringConvertible")
XCTAssertEqual(uuidFromString?.description, originalString, "Round-tripped description must match original UUID string")

let uuid = UUID(uuidString: originalString)!
XCTAssertEqual(uuid, UUID(uuid.description), "UUID must round-trip through LosslessStringConvertible")

let invalidString = "not-a-uuid"
let invalidUUID = UUID(invalidString)
XCTAssertNil(invalidUUID, "Invalid UUID strings must result in nil from LosslessStringConvertible initializer")
}

}